Added support for custom claims binders

vip32 · May 12, 2019 · 59f8a85 · 59f8a85
1 parent cab6c9f
commit 59f8a85
Show file tree

Hide file tree

Showing 17 changed files with 94 additions and 29 deletions.
diff --git a/Source/FunctionMonkey.Abstractions/Builders/IAuthorizationBuilder.cs b/Source/FunctionMonkey.Abstractions/Builders/IAuthorizationBuilder.cs
@@ -39,6 +39,15 @@ public interface IAuthorizationBuilder
         /// <returns>The builder for use in a Fluent API</returns>
         IAuthorizationBuilder TokenValidator<TTokenValidator>(string header=null) where TTokenValidator : ITokenValidator;
 
+        /// <summary>
+        /// Allows a custom claims binder to be registered. This can only occur globally and must take responsibility
+        /// for all claims mapping.
+        /// </summary>
+        /// <typeparam name="TCustomClaimsBinder">The type of the claims binder</typeparam>
+        /// <returns>The builder for use in a Fluent API</returns>
+        IAuthorizationBuilder CustomClaimsBinder<TCustomClaimsBinder>()
+            where TCustomClaimsBinder : ICommandClaimsBinder;
+
         /// <summary>
         /// Allows the default authorization mode for HTTP functions to be set. Defaults to Function Code if this method is not used.
         /// </summary>

diff --git a/Source/FunctionMonkey.Abstractions/FunctionMonkey.Abstractions.csproj b/Source/FunctionMonkey.Abstractions/FunctionMonkey.Abstractions.csproj
@@ -2,13 +2,13 @@
 
   <PropertyGroup>
     <TargetFramework>netstandard2.0</TargetFramework>
-    <Version>2.1.0</Version>
+    <Version>2.2.0</Version>
     <Authors>James Randall</Authors>
     <PackageLicenseUrl>https://raw.githubusercontent.com/JamesRandall/AzureFromTheTrenches.Commanding/master/LICENSE</PackageLicenseUrl>
     <PackageProjectUrl>https://commanding.azurefromthetrenches.com/</PackageProjectUrl>
     <RepositoryUrl>https://github.com/JamesRandall/FunctionMonkey.git</RepositoryUrl>
-    <AssemblyVersion>2.1.0.0</AssemblyVersion>
-    <FileVersion>2.1.0.0</FileVersion>
+    <AssemblyVersion>2.2.0.0</AssemblyVersion>
+    <FileVersion>2.2.0.0</FileVersion>
   </PropertyGroup>
 
   <ItemGroup>

diff --git a/Source/FunctionMonkey.Abstractions/ICommandClaimsBinder.cs b/Source/FunctionMonkey.Abstractions/ICommandClaimsBinder.cs
@@ -1,4 +1,5 @@
 using System.Security.Claims;
+using System.Threading.Tasks;
 using AzureFromTheTrenches.Commanding.Abstractions;
 
 namespace FunctionMonkey.Abstractions
@@ -13,5 +14,11 @@ public interface ICommandClaimsBinder
         /// Binds the claims in the principal onto properties of the command
         /// </summary>
         bool Bind(ClaimsPrincipal principal, ICommand command);        
+
+        /// <summary>
+        /// Binds the claims in the principal onto properties of the command. If this returns null then
+        /// the non-async binder will be called.
+        /// </summary>
+        Task<bool> BindAsync(ClaimsPrincipal principal, ICommand command);
     }
 }
diff --git a/Source/FunctionMonkey.Commanding.Abstractions/FunctionMonkey.Commanding.Abstractions.csproj b/Source/FunctionMonkey.Commanding.Abstractions/FunctionMonkey.Commanding.Abstractions.csproj
@@ -2,14 +2,14 @@
 
   <PropertyGroup>
     <TargetFramework>netstandard2.0</TargetFramework>
-    <Version>2.1.0</Version>
+    <Version>2.2.0</Version>
     <Company>James Randall</Company>
     <Authors>James Randall</Authors>
     <PackageLicenseUrl>https://raw.githubusercontent.com/JamesRandall/AzureFromTheTrenches.Commanding/master/LICENSE</PackageLicenseUrl>
     <PackageProjectUrl>https://functionmonkey.azurefromthetrenches.com/</PackageProjectUrl>
     <RepositoryUrl>https://github.com/JamesRandall/FunctionMonkey.git</RepositoryUrl>
-    <AssemblyVersion>2.1.0.0</AssemblyVersion>
-    <FileVersion>2.1.0.0</FileVersion>
+    <AssemblyVersion>2.2.0.0</AssemblyVersion>
+    <FileVersion>2.2.0.0</FileVersion>
   </PropertyGroup>
 
 </Project>
diff --git a/...onkey.Commanding.Cosmos.Abstractions/FunctionMonkey.Commanding.Cosmos.Abstractions.csproj b/...onkey.Commanding.Cosmos.Abstractions/FunctionMonkey.Commanding.Cosmos.Abstractions.csproj
@@ -2,9 +2,9 @@
 
   <PropertyGroup>
     <TargetFramework>netstandard2.0</TargetFramework>
-    <Version>2.1.0</Version>
-    <AssemblyVersion>2.1.0.0</AssemblyVersion>
-    <FileVersion>2.1.0.0</FileVersion>
+    <Version>2.2.0</Version>
+    <AssemblyVersion>2.2.0.0</AssemblyVersion>
+    <FileVersion>2.2.0.0</FileVersion>
     <Authors>James Randall</Authors>
     <Company>James Randall</Company>
     <PackageLicenseUrl>https://raw.githubusercontent.com/JamesRandall/AzureFromTheTrenches.Commanding/master/LICENSE</PackageLicenseUrl>

diff --git a/Source/FunctionMonkey.Compiler/FunctionMonkey.Compiler.csproj b/Source/FunctionMonkey.Compiler/FunctionMonkey.Compiler.csproj
@@ -3,7 +3,7 @@
   <PropertyGroup>
     <OutputType>Exe</OutputType>
     <TargetFramework>netcoreapp2.1</TargetFramework>    
-    <Version>2.1.1</Version>
+    <Version>2.2.0</Version>
     <AssemblyName>FunctionMonkey.Compiler</AssemblyName>
     <PackageId>FunctionMonkey.Compiler</PackageId>
   </PropertyGroup>
@@ -385,8 +385,8 @@
     <IntermediatePackDir>$(MSBuildProjectDirectory)/bin/$(Configuration)/publish/</IntermediatePackDir>
     <PublishDir>$(IntermediatePackDir)$(TargetFramework)/</PublishDir>
     <NuspecProperties>publishDir=$([MSBuild]::NormalizeDirectory($(IntermediatePackDir)))</NuspecProperties>
-    <AssemblyVersion>2.1.1.0</AssemblyVersion>
-    <FileVersion>2.1.1.0</FileVersion>
+    <AssemblyVersion>2.2.0.0</AssemblyVersion>
+    <FileVersion>2.2.1.0</FileVersion>
     <PackageReleaseNotes></PackageReleaseNotes>
   </PropertyGroup>
 

diff --git a/Source/FunctionMonkey.Compiler/FunctionMonkey.Compiler.nuspec b/Source/FunctionMonkey.Compiler/FunctionMonkey.Compiler.nuspec
@@ -2,7 +2,7 @@
 <package xmlns="http://schemas.microsoft.com/packaging/2012/06/nuspec.xsd">
   <metadata>
     <id>FunctionMonkey.Compiler</id>
-    <version>2.1.1</version>
+    <version>2.2.0</version>
     <authors>James Randall</authors>
     <description>Generates Azure Functions from command registrations</description>
     <licenseUrl>https://raw.githubusercontent.com/JamesRandall/AzureFromTheTrenches.Commanding/master/LICENSE</licenseUrl>

diff --git a/Source/FunctionMonkey.Compiler/Templates/http.csharp.handlebars b/Source/FunctionMonkey.Compiler/Templates/http.csharp.handlebars
@@ -222,7 +222,15 @@ namespace {{Namespace}}
             {{#if ValidatesToken}}
             var claimsBinder = (FunctionMonkey.Abstractions.ICommandClaimsBinder)
                 FunctionMonkey.Runtime.ServiceProvider.GetService(typeof(FunctionMonkey.Abstractions.ICommandClaimsBinder));
-            claimsBinder.Bind(principal, command);
+            var claimsBinderTask = claimsBinder.BindAsync(principal, command);
+            if (claimsBinderTask == null)
+            {
+                claimsBinder.Bind(principal, command);
+            }
+            else
+            {
+                await claimsBinderTask;
+            }
             {{/if}}
 
             {{#if HasHttpResponseHandler}}

diff --git a/Source/FunctionMonkey.Compiler/Templates/signalrcommandnegotiate.csharp.handlebars b/Source/FunctionMonkey.Compiler/Templates/signalrcommandnegotiate.csharp.handlebars
@@ -220,7 +220,15 @@ namespace {{Namespace}}
             {{#if ValidatesToken}}
             var claimsBinder = (FunctionMonkey.Abstractions.ICommandClaimsBinder)
                 FunctionMonkey.Runtime.ServiceProvider.GetService(typeof(FunctionMonkey.Abstractions.ICommandClaimsBinder));
-            claimsBinder.Bind(principal, command);
+            var claimsBinderTask = claimsBinder.BindAsync(principal, command);
+            if (claimsBinderTask == null)
+            {
+                claimsBinder.Bind(principal, command);
+            }
+            else
+            {
+                await claimsBinderTask;
+            }
             {{/if}}
 
             {{#if HasHttpResponseHandler}}

diff --git a/Source/FunctionMonkey.FluentValidation/FunctionMonkey.FluentValidation.csproj b/Source/FunctionMonkey.FluentValidation/FunctionMonkey.FluentValidation.csproj
@@ -2,14 +2,14 @@
 
   <PropertyGroup>
     <TargetFramework>netstandard2.0</TargetFramework>
-    <Version>2.1.0</Version>
+    <Version>2.2.0</Version>
     <Authors>James Randall</Authors>
     <Company>James Randall</Company>
     <PackageLicenseUrl>https://raw.githubusercontent.com/JamesRandall/AzureFromTheTrenches.Commanding/master/LICENSE</PackageLicenseUrl>
     <PackageProjectUrl>https://commanding.azurefromthetrenches.com/</PackageProjectUrl>
     <RepositoryUrl>https://github.com/JamesRandall/FunctionMonkey.git</RepositoryUrl>
-    <AssemblyVersion>2.1.0.0</AssemblyVersion>
-    <FileVersion>2.1.0.0</FileVersion>
+    <AssemblyVersion>2.2.0.0</AssemblyVersion>
+    <FileVersion>2.2.0.0</FileVersion>
   </PropertyGroup>
 
   <ItemGroup>

diff --git a/Source/FunctionMonkey.SignalR/FunctionMonkey.SignalR.csproj b/Source/FunctionMonkey.SignalR/FunctionMonkey.SignalR.csproj
@@ -2,7 +2,7 @@
 
   <PropertyGroup>
     <TargetFramework>netstandard2.0</TargetFramework>
-    <Version>2.1.0</Version>
+    <Version>2.2.0</Version>
   </PropertyGroup>
 
   <ItemGroup>

diff --git a/Source/FunctionMonkey.Testing/FunctionMonkey.Testing.csproj b/Source/FunctionMonkey.Testing/FunctionMonkey.Testing.csproj
@@ -2,16 +2,16 @@
 
   <PropertyGroup>
     <TargetFramework>netcoreapp2.2</TargetFramework>
-    <Version>2.1.2</Version>
+    <Version>2.2.0</Version>
     <Authors>James Randall</Authors>
     <Company>James Randall</Company>
     <Copyright></Copyright>
     <PackageLicenseUrl>https://raw.githubusercontent.com/JamesRandall/AzureFromTheTrenches.Commanding/master/LICENSE</PackageLicenseUrl>
     <RepositoryUrl>https://github.com/JamesRandall/FunctionMonkey.git</RepositoryUrl>
     <PackageProjectUrl>https://functionmonkey.azurefromthetrenches.com/</PackageProjectUrl>
     <PackageRequireLicenseAcceptance>true</PackageRequireLicenseAcceptance>
-    <AssemblyVersion>2.1.2.0</AssemblyVersion>
-    <FileVersion>2.1.2.0</FileVersion>
+    <AssemblyVersion>2.2.0.0</AssemblyVersion>
+    <FileVersion>2.2.0.0</FileVersion>
   </PropertyGroup>
 
   <ItemGroup>

diff --git a/Source/FunctionMonkey.Testing/Mocks/CommandClaimsBinderMock.cs b/Source/FunctionMonkey.Testing/Mocks/CommandClaimsBinderMock.cs
@@ -1,4 +1,5 @@
 using System.Security.Claims;
+using System.Threading.Tasks;
 using AzureFromTheTrenches.Commanding.Abstractions;
 using FunctionMonkey.Abstractions;
 
@@ -10,5 +11,10 @@ public bool Bind(ClaimsPrincipal principal, ICommand command)
         {
             return false;
         }
+
+        public Task<bool> BindAsync(ClaimsPrincipal principal, ICommand command)
+        {
+            return null;
+        }
     }
 }
diff --git a/Source/FunctionMonkey/Builders/AuthorizationBuilder.cs b/Source/FunctionMonkey/Builders/AuthorizationBuilder.cs
@@ -14,6 +14,8 @@ internal class AuthorizationBuilder : IAuthorizationBuilder
         public string AuthorizationHeader { get; set; }
 
         public Type DefaultClaimsPrincipalAuthorizationType { get; set; }
+
+        public Type CustomClaimsBinderType { get; set; }
 
         public AuthorizationTypeEnum AuthorizationDefaultValue { get; set; } = AuthorizationTypeEnum.Function;
 
@@ -24,6 +26,12 @@ public IAuthorizationBuilder TokenValidator<TTokenValidator>(string header=null)
             return this;
         }
 
+        public IAuthorizationBuilder CustomClaimsBinder<TCustomClaimsBinder>() where TCustomClaimsBinder : ICommandClaimsBinder
+        {
+            CustomClaimsBinderType = typeof(TCustomClaimsBinder);
+            return this;
+        }
+
         public IAuthorizationBuilder AuthorizationDefault(AuthorizationTypeEnum authorizationDefault)
         {
             AuthorizationDefaultValue = authorizationDefault;

diff --git a/Source/FunctionMonkey/FunctionMonkey.csproj b/Source/FunctionMonkey/FunctionMonkey.csproj
@@ -2,16 +2,16 @@
 
   <PropertyGroup>
     <TargetFramework>netstandard2.0</TargetFramework>
-    <Version>2.1.1</Version>
+    <Version>2.2.0</Version>
     <GeneratePackageOnBuild>false</GeneratePackageOnBuild>
     <Company />
     <Authors>James Randall</Authors>
     <PackageLicenseUrl>https://raw.githubusercontent.com/JamesRandall/AzureFromTheTrenches.Commanding/master/LICENSE</PackageLicenseUrl>
     <PackageProjectUrl>https://functionmonkey.azurefromthetrenches.com/</PackageProjectUrl>
     <RepositoryUrl>https://github.com/JamesRandall/FunctionMonkey.git</RepositoryUrl>
     <PackageRequireLicenseAcceptance>true</PackageRequireLicenseAcceptance>
-    <AssemblyVersion>2.1.1.0</AssemblyVersion>
-    <FileVersion>2.1.1.0</FileVersion>
+    <AssemblyVersion>2.2.0.0</AssemblyVersion>
+    <FileVersion>2.2.0.0</FileVersion>
   </PropertyGroup>
 
   <ItemGroup>

diff --git a/Source/FunctionMonkey/Infrastructure/CommandClaimsBinder.cs b/Source/FunctionMonkey/Infrastructure/CommandClaimsBinder.cs
@@ -1,6 +1,7 @@
 using System;
 using System.Collections.Generic;
 using System.Security.Claims;
+using System.Threading.Tasks;
 using AzureFromTheTrenches.Commanding.Abstractions;
 using FunctionMonkey.Abstractions;
 
@@ -25,5 +26,16 @@ public bool Bind(ClaimsPrincipal principal, ICommand command)
 
             return false;
         }
+
+        public Task<bool> BindAsync(ClaimsPrincipal principal, ICommand command)
+        {
+            if (_mappers.TryGetValue(command.GetType(), out var binder))
+            {
+                binder(command, principal);
+                return Task.FromResult(true);
+            }
+
+            return Task.FromResult(false);
+        }
     }
 }
diff --git a/Source/FunctionMonkey/RuntimeInstance.cs b/Source/FunctionMonkey/RuntimeInstance.cs
@@ -160,10 +160,17 @@ private void SetupAuthorization(FunctionHostBuilder builder, FunctionBuilder fun
 
             // don't register the token validator type here - that gets passed down to the HTTP function
             // definitions to allow for function overrides and so is registered as part of HTTP dependencies
-
-            ICommandClaimsBinder commandClaimsBinder = authorizationBuilder.ClaimsMappingBuilder.Build(
-                functionBuilder.GetHttpFunctionDefinitions().Select(x => x.CommandType).ToArray());
-            ServiceCollection.AddSingleton(commandClaimsBinder);
+            if (authorizationBuilder.CustomClaimsBinderType == null)
+            {
+                ICommandClaimsBinder commandClaimsBinder = authorizationBuilder.ClaimsMappingBuilder.Build(
+                    functionBuilder.GetHttpFunctionDefinitions().Select(x => x.CommandType).ToArray());
+                ServiceCollection.AddSingleton(commandClaimsBinder);
+            }
+            else
+            {
+                ServiceCollection.AddTransient(typeof(ICommandClaimsBinder),
+                    authorizationBuilder.CustomClaimsBinderType);
+            }
         }
 
         private IFunctionAppConfiguration LocateConfiguration(Assembly functionAppConfigurationAssembly)