last ...

Configurations/XApiKeyConfiguration.cs

@@ -5,6 +5,11 @@ namespace xIds.Configurations
     /// </summary>
     public class XApiKeyConfiguration
     {
+        /// <summary>
+        /// Generated Api Keys Prefix ...
+        /// </summary>
+        public string ApiKeyPrefix { get; set; }
+
         /// <summary>
         /// Default expiration in minutes (e.g., 43200 = 30 days)
         /// </summary>

Controllers/Account/AccountController+Admin.cs

@@ -1,12 +1,12 @@
 using System;
-using System.Collections.Generic;
-using System.Threading.Tasks;
-using Microsoft.AspNetCore.Authorization;
-using Microsoft.AspNetCore.Mvc;
 using xIdentityHelper;
 using xCommons.Attributes;
 using xCommons.Extensions;
 using xIdentityModels.Dtos;
+using System.Threading.Tasks;
+using Microsoft.AspNetCore.Mvc;
+using System.Collections.Generic;
+using Microsoft.AspNetCore.Authorization;
 using static IdentityServer4.IdentityServerConstants;
 
 namespace xIds.Controllers

Controllers/Account/AccountController+Authentication.cs

@@ -1,17 +1,17 @@
 using System;
-using System.Threading.Tasks;
-using IdentityModel.Client;
-using Microsoft.AspNetCore.Authorization;
-using Microsoft.AspNetCore.Mvc;
 using xIdentityHelper;
 using xCommons.Attributes;
 using xCommons.Extensions;
+using IdentityModel.Client;
 using xExceptions.Constants;
-using xIdentityModels.Extensions;
+using System.Threading.Tasks;
 using xIdentityModels.Models;
-using static IdentityServer4.IdentityServerConstants;
+using Microsoft.AspNetCore.Mvc;
-using static xIdentityHelper.XApiScopeHelper;
+using xIdentityModels.Extensions;
 using Microsoft.Extensions.Logging;
+using Microsoft.AspNetCore.Authorization;
+using static xIdentityHelper.XApiScopeHelper;
+using static IdentityServer4.IdentityServerConstants;
 
 namespace xIds.Controllers
 {

Controllers/Account/AccountController+Friendship.cs

@@ -1,17 +1,17 @@
 using System;
-using System.Collections.Generic;
 using System.Linq;
-using System.Threading.Tasks;
+using xModels.Dtos;
-using Microsoft.AspNetCore.Authorization;
+using xIdentityHelper;
-using Microsoft.AspNetCore.Mvc;
 using xCommons.Attributes;
 using xCommons.Extensions;
-using xExceptions.Constants;
-using xIdentityHelper;
-using xIdentityModels.Constants;
 using xIdentityModels.Dtos;
+using xExceptions.Constants;
+using System.Threading.Tasks;
+using Microsoft.AspNetCore.Mvc;
+using xIdentityModels.Constants;
+using System.Collections.Generic;
 using xIdentityModels.Navigations;
-using xModels.Dtos;
+using Microsoft.AspNetCore.Authorization;
 using static IdentityServer4.IdentityServerConstants;
 
 namespace xIds.Controllers

Controllers/Account/AccountController+Open.cs

@@ -1,10 +1,10 @@
 using System;
-using System.Threading.Tasks;
-using Microsoft.AspNetCore.Authorization;
-using Microsoft.AspNetCore.Mvc;
-using xCommons.Attributes;
 using xCommons.Constants;
+using xCommons.Attributes;
 using xIdentityModels.Dtos;
+using System.Threading.Tasks;
+using Microsoft.AspNetCore.Mvc;
+using Microsoft.AspNetCore.Authorization;
 
 namespace xIds.Controllers
 {

Controllers/Account/AccountController+Profile.cs

@@ -1,17 +1,17 @@
 using System;
-using System.Collections.Generic;
-using System.Collections.ObjectModel;
 using System.Linq;
-using System.Threading.Tasks;
+using xModels.Dtos;
-using Microsoft.AspNetCore.Authorization;
-using Microsoft.AspNetCore.Http;
-using Microsoft.AspNetCore.Mvc;
 using xIdentityHelper;
 using xCommons.Attributes;
 using xCommons.Extensions;
 using xIdentityModels.Dtos;
+using System.Threading.Tasks;
 using xIdentityModels.Models;
-using xModels.Dtos;
+using Microsoft.AspNetCore.Mvc;
+using Microsoft.AspNetCore.Http;
+using System.Collections.Generic;
+using System.Collections.ObjectModel;
+using Microsoft.AspNetCore.Authorization;
 using static IdentityServer4.IdentityServerConstants;
 
 namespace xIds.Controllers

Controllers/Account/AccountController+Query.cs

@@ -1,11 +1,11 @@
 using System;
-using System.Threading.Tasks;
+using xModels.Dtos;
-using Microsoft.AspNetCore.Authorization;
+using xIdentityHelper;
-using Microsoft.AspNetCore.Mvc;
 using xCommons.Attributes;
 using xCommons.Extensions;
-using xIdentityHelper;
+using System.Threading.Tasks;
-using xModels.Dtos;
+using Microsoft.AspNetCore.Mvc;
+using Microsoft.AspNetCore.Authorization;
 using static IdentityServer4.IdentityServerConstants;
 
 namespace xIds.Controllers

Controllers/Account/AccountController+Registration.cs

@@ -1,15 +1,15 @@
 using System;
-using System.Collections.Generic;
-using System.Threading.Tasks;
-using Microsoft.AspNetCore.Authorization;
-using Microsoft.AspNetCore.Http;
-using Microsoft.AspNetCore.Mvc;
 using xIdentityHelper;
 using xCommons.Attributes;
 using xCommons.Extensions;
 using xExceptions.Constants;
-using xIdentityModels.Constants;
+using System.Threading.Tasks;
 using xIdentityModels.Models;
+using Microsoft.AspNetCore.Mvc;
+using Microsoft.AspNetCore.Http;
+using xIdentityModels.Constants;
+using System.Collections.Generic;
+using Microsoft.AspNetCore.Authorization;
 using static IdentityServer4.IdentityServerConstants;
 
 namespace xIds.Controllers

Controllers/Account/AccountController+Search.cs

@@ -1,14 +1,14 @@
 using System;
-using System.Collections.Generic;
 using System.Linq;
-using System.Threading.Tasks;
+using xModels.Dtos;
-using Microsoft.AspNetCore.Authorization;
+using xIdentityHelper;
-using Microsoft.AspNetCore.Mvc;
 using xCommons.Attributes;
 using xCommons.Extensions;
-using xIdentityHelper;
 using xIdentityModels.Dtos;
-using xModels.Dtos;
+using System.Threading.Tasks;
+using Microsoft.AspNetCore.Mvc;
+using System.Collections.Generic;
+using Microsoft.AspNetCore.Authorization;
 using static IdentityServer4.IdentityServerConstants;
 
 namespace xIds.Controllers

Controllers/Account/AccountController+Test.cs

@@ -1,8 +1,8 @@
 using System.Linq;
-using Microsoft.AspNetCore.Authorization;
-using Microsoft.AspNetCore.Mvc;
 using xIdentityHelper;
 using xCommons.Attributes;
+using Microsoft.AspNetCore.Mvc;
+using Microsoft.AspNetCore.Authorization;
 using static IdentityServer4.IdentityServerConstants;
 
 namespace xIds.Controllers
@@ -156,6 +156,19 @@ namespace xIds.Controllers
             //
             return Ok(result);
         }
+        
+        [RequireXPowered]
+        [HttpGet("Test/HiApiKeyAccess")]
+        [Authorize(LocalApi.PolicyName)]
+        [Authorize(Policy = XPolicies.ApiKeyAccess)]
+        public ActionResult<string> HiApiKeyAccess()
+        {
+            //
+            var result = $"Hi ApiKey Access, is Passed ...";
+
+            //
+            return Ok(result);            
+        }
         #endregion        
     }
 }

Controllers/AccountController.cs

@@ -1,9 +1,9 @@
-using Microsoft.AspNetCore.Mvc;
+using xIds.Interfaces;
-using Microsoft.Extensions.Logging;
-using xCommons.Configurations;
 using xCommons.Providers;
 using xIds.Controllers.Base;
-using xIds.Interfaces;
+using xCommons.Configurations;
+using Microsoft.AspNetCore.Mvc;
+using Microsoft.Extensions.Logging;
 
 namespace xIds.Controllers
 {

Controllers/Applications/ApplicationsController+ApiKey.cs

@@ -0,0 +1,9 @@
+namespace xIds.Controllers
+{
+    public partial class ApplicationsController
+    {
+        //
+        #region ApiKey ...
+        #endregion                
+    }
+}

Controllers/Applications/ApplicationsController+ApiKeyUsage.cs

@@ -0,0 +1,9 @@
+namespace xIds.Controllers
+{
+    public partial class ApplicationsController
+    {
+        //
+        #region ApiKeyUsage ...
+        #endregion        
+    }
+}

Controllers/Applications/ApplicationsController+Application.cs

@@ -0,0 +1,31 @@
+using System;
+using xIdentityHelper;
+using System.Threading;
+using xCommons.Attributes;
+using xIdentityModels.Dtos;
+using System.Threading.Tasks;
+using Microsoft.AspNetCore.Mvc;
+using Microsoft.AspNetCore.Authorization;
+using static IdentityServer4.IdentityServerConstants;
+
+namespace xIds.Controllers
+{
+    public partial class ApplicationsController
+    {
+        //
+        #region Application ...
+        [HttpPost]
+        [RequireXPowered]
+        [Authorize(LocalApi.PolicyName)]
+        [Authorize(Policy = XPolicies.EnabledUser)]
+        public async Task<ActionResult<XApplicationDto>> CreateApplication(
+            [FromBody] XApplicationDto request,
+            CancellationToken cancellationToken = default
+        )
+        {
+            //
+            throw new NotImplementedException("");
+        }
+        #endregion
+    }
+}

Controllers/ApplicationsController.cs

@@ -0,0 +1,29 @@
+using xIds.Interfaces;
+using xCommons.Providers;
+using xIds.Controllers.Base;
+using xCommons.Configurations;
+using Microsoft.AspNetCore.Mvc;
+using Microsoft.Extensions.Logging;
+
+namespace xIds.Controllers
+{
+    /// <summary>
+    /// Provide all available tools for manipulating users and accounts
+    /// </summary>
+    [ApiController]
+    public partial class ApplicationsController : XIBaseController
+    {
+        public ApplicationsController(
+            ILogger<ApplicationsController> logger,
+            XAppConfiguration appConfiguration,
+            IXIdentityManager identityManager,
+            XValidationProvider validationProvider
+        ) : base(
+            logger,
+            appConfiguration,
+            identityManager,
+            validationProvider
+        )
+        { }
+    }
+}

DI/XDIHelperExtension.cs

@@ -25,7 +25,9 @@ using xIdentityModels.Configurations;
 using Microsoft.AspNetCore.Authorization;
 using Microsoft.AspNetCore.HttpOverrides;
 using Microsoft.Extensions.Configuration;
+using Microsoft.AspNetCore.Authentication;
 using Microsoft.Extensions.DependencyInjection;
+using xIdentityService.Constants;
 
 namespace xIds.DI
 {
@@ -147,6 +149,67 @@ namespace xIds.DI
             services.AddSingleton<XDataServiceConfiguration>(dataServiceConfiguration);
         }
 
+        /// <summary>
+        /// Add Specified ApiKey Configurations Instance ...
+        /// </summary>
+        /// <param name="source"></param>
+        /// <param name="configuration"></param>
+        public static void AddXApiKeyConfiguration(
+            this IServiceCollection source,
+            XApiKeyConfiguration configuration
+        )
+        {
+            //
+            if (configuration.IsNull())
+            {
+                return;
+            }
+
+            //
+            source.AddSingleton(configuration);
+        }
+
+        /// <summary>
+        /// Extract APpi KLey Configurations from app settings
+        /// and Register in Services ... 
+        /// </summary>
+        /// <param name="source"></param>
+        /// <param name="configuration"></param>
+        public static void AddXApiKeyConfiguration(
+            this IServiceCollection source,
+            IConfiguration configuration
+        )
+        {
+            //
+            var config = configuration.GetXApiKeyConfiguration();
+            if (config.IsNull())
+            {
+                return;
+            }
+
+            //
+            source.AddXApiKeyConfiguration(config);
+        }
+
+        /// <summary>
+        /// Register Application Provider ...
+        /// Managing Applications/ApiKeys/ApiKeyUsages ...
+        /// </summary>
+        /// <param name="source"></param>
+        /// <param name="configuration"></param>
+        public static void AddXApplicationProvider(
+            this IServiceCollection source,
+            IConfiguration configuration
+        )
+        {
+            //
+            source.AddXApiKeyConfiguration(configuration);
+            
+            //
+            source.AddMemoryCache();
+            source.AddScoped<IXApplicationProvider, XApplicationProvider>();
+        }
+
         /// <summary>
         /// Register All Requirements For XIdentityServer Usage
         /// </summary>
@@ -336,15 +399,22 @@ namespace xIds.DI
         /// </summary>
         /// <param name="services"></param>
         /// <param name="configuration"></param>
+        /// <param name="addApiKeyAuthentication"></param>
         public static void AddXIdentityServerAuthentication(
             this IServiceCollection services,
-            IConfiguration configuration
+            IConfiguration configuration,
+            bool addApiKeyAuthentication = false
         )
         {
             //
             services.AddXIdentityResourceConfiguration(configuration);
-            services.AddAuthentication()
+
-                .AddJwtBearer(options =>
+            //
+            var authBuilder = services.AddAuthentication();
+            
+            //
+            // Add JWT Bearer ...
+            authBuilder.AddJwtBearer(options =>
             {
                 //
                 options.SaveToken = true;
@@ -354,6 +424,16 @@ namespace xIds.DI
                 options.ForwardDefault = XAuthentication.IDENTITY_SERVER_LOCAL_API;
             })
             .AddLocalApi();
+
+            //
+            if (addApiKeyAuthentication)
+            {
+                //
+                authBuilder.AddScheme<AuthenticationSchemeOptions, XApiKeyAuthenticationHandler>(
+                    XAuthenticationScheme.XApiKey.GetStringValue(),
+                    options => {}
+                );
+            }
         }
 
         /// <summary>

Helpers/XApiKeyHelper.cs

@@ -9,11 +9,29 @@ namespace xIds.Helpers
     /// </summary>
     public static class XApiKeyHelper
     {
+        /// <summary>
+        /// Compute Hash of Specified Content using SHA256 ...
+        /// </summary>
+        /// <param name="plain"></param>
+        /// <returns></returns>
+        public static string ComputeHash(string plain)
+        {
+            //
+            using var sha256 = SHA256.Create();
+            var hashBytes = sha256.ComputeHash(Encoding.UTF8.GetBytes(plain));
+            var result = BitConverter.ToString(hashBytes)
+                .Replace("-", "")
+                .ToLower();
+
+            //
+            return result;
+        }
+
         /// <summary>
         /// Generate an Api Key ...
         /// </summary>
         /// <returns></returns>
-        public static (string plainKey, string hash, string prefix) Generate()
+        public static (string plainKey, string hash, string prefix) Generate(string keyPrefix)
         {
             //
             // Generate 32 bytes of cryptographically secure random data
@@ -25,16 +43,12 @@ namespace xIds.Helpers
 
             //
             // Format: xapp_{base64url}
-            var plainKey = $"xapp_{Convert.ToBase64String(randomBytes)
+            var plainKey = $"{keyPrefix}_{Convert.ToBase64String(randomBytes)
                 .Replace("+", "-").Replace("/", "_").TrimEnd('=')}";
 
             //
-            // Hash with SHA256 for storage (never store plain key)
+            // Compute Hash ...
-            using (var sha256 = SHA256.Create())
+            var hash = ComputeHash(plainKey);
-            {
-                //
-                var hashBytes = sha256.ComputeHash(Encoding.UTF8.GetBytes(plainKey));
-                var hash = BitConverter.ToString(hashBytes).Replace("-", "").ToLower();
 
             //
             // Prefix for quick identification (first 12 chars)
@@ -43,7 +57,6 @@ namespace xIds.Helpers
             //
             return (plainKey, hash, prefix);
         }
-        }
 
         /// <summary>
         /// Verify Generating Api Key ...
@@ -57,16 +70,8 @@ namespace xIds.Helpers
         )
         {
             //
-            using (var sha256 = SHA256.Create())
+            var hash = ComputeHash(plainKey);
-            {
+            return hash == storedHash;
-                //
-                var hashBytes = sha256.ComputeHash(Encoding.UTF8.GetBytes(plainKey));
-                var computedHash = BitConverter.ToString(hashBytes)
-                    .Replace("-", "").ToLower();
-
-                //
-                return computedHash == storedHash;
-            }
         }
     }
 }

Interfaces/IXApplicationProvider.cs

@@ -194,7 +194,7 @@ namespace xIds.Interfaces
         /// <param name="cancellationToken"></param>
         /// <returns></returns>
         Task<XApiKeyDto> UpdateApiKeyAsync(
-            int id,
+            Guid id,
             XApiKeyDto item,
             XUserClaimsInfoDto userInfo = null,
             CancellationToken cancellationToken = default
@@ -209,7 +209,7 @@ namespace xIds.Interfaces
         /// <param name="cancellationToken"></param>
         /// <returns></returns>
         Task<XApiKeyDto> RemoveApiKeyAsync(
-            int id,
+            Guid id,
             bool softDelete = true,
             XUserClaimsInfoDto userInfo = null,
             CancellationToken cancellationToken = default
@@ -225,7 +225,7 @@ namespace xIds.Interfaces
         /// <param name="cancellationToken"></param>
         /// <returns></returns>
         Task<XApiKeyDto> GetApiKeyAsync(
-            int id,
+            Guid id,
             bool ignoreSoftDeleteds = true,
             XUserClaimsInfoDto userInfo = null,
             Func<IQueryable<XApiKey>, IIncludableQueryable<XApiKey, object>> includeBuilder = null,
@@ -348,7 +348,7 @@ namespace xIds.Interfaces
         /// <param name="cancellationToken"></param>
         /// <returns></returns>
         Task<XApiKeyUsageDto> UpdateApiKeyUsageAsync(
-            int id,
+            long id,
             XApiKeyUsageDto item,
             XUserClaimsInfoDto userInfo = null,
             CancellationToken cancellationToken = default
@@ -363,7 +363,7 @@ namespace xIds.Interfaces
         /// <param name="cancellationToken"></param>
         /// <returns></returns>
         Task<XApiKeyUsageDto> RemoveApiKeyUsageAsync(
-            int id,
+            long id,
             bool softDelete = true,
             XUserClaimsInfoDto userInfo = null,
             CancellationToken cancellationToken = default
@@ -379,7 +379,7 @@ namespace xIds.Interfaces
         /// <param name="cancellationToken"></param>
         /// <returns></returns>
         Task<XApiKeyUsageDto> GetApiKeyUsageAsync(
-            int id,
+            long id,
             bool ignoreSoftDeleteds = true,
             XUserClaimsInfoDto userInfo = null,
             Func<IQueryable<XApiKeyUsage>, IIncludableQueryable<XApiKeyUsage, object>> includeBuilder = null,
@@ -547,12 +547,14 @@ namespace xIds.Interfaces
         /// </summary>
         /// <param name="apiKey"></param>
         /// <param name="clientIP"></param>
+        /// <param name="requiredScope"></param>
         /// <param name="userInfo"></param>
         /// <param name="cancellationToken"></param>
         /// <returns></returns>
-        Task<bool> ValidateApiKey(
+        Task<XApiKeyValidationResult> ValidateApiKey(
             string apiKey,
             string clientIP,
+            string requiredScope = null,
             XUserClaimsInfoDto userInfo = null,
             CancellationToken cancellationToken = default
         );
@@ -632,7 +634,7 @@ namespace xIds.Interfaces
         /// <param name="sources"></param>
         /// <param name="cancellationToken"></param>
         /// <returns></returns>
-        Task<XApiKeyDto> EnrichRangeAsync(
+        Task<IEnumerable<XApiKeyDto>> EnrichRangeAsync(
             IEnumerable<XApiKey> sources,
             CancellationToken cancellationToken = default
         );
@@ -643,7 +645,7 @@ namespace xIds.Interfaces
         /// <param name="sources"></param>
         /// <param name="cancellationToken"></param>
         /// <returns></returns>
-        Task<XApiKeyDto> EnrichRangeAsync(
+        Task<IEnumerable<XApiKeyDto>> EnrichRangeAsync(
             IEnumerable<XApiKeyDto> sources,
             CancellationToken cancellationToken = default
         );
@@ -654,7 +656,7 @@ namespace xIds.Interfaces
         /// <param name="sources"></param>
         /// <param name="cancellationToken"></param>
         /// <returns></returns>
-        Task<XApiKeyUsageDto> EnrichRangeAsync(
+        Task<IEnumerable<XApiKeyUsageDto>> EnrichRangeAsync(
             IEnumerable<XApiKeyUsage> sources,
             CancellationToken cancellationToken = default
         );
@@ -665,7 +667,7 @@ namespace xIds.Interfaces
         /// <param name="sources"></param>
         /// <param name="cancellationToken"></param>
         /// <returns></returns>
-        Task<XApplicationDto> EnrichRangeAsync(
+        Task<IEnumerable<XApplicationDto>> EnrichRangeAsync(
             IEnumerable<XApplication> sources,
             CancellationToken cancellationToken = default
         );
@@ -676,7 +678,7 @@ namespace xIds.Interfaces
         /// <param name="sources"></param>
         /// <param name="cancellationToken"></param>
         /// <returns></returns>
-        Task<XApiKeyUsageDto> EnrichRangeAsync(
+        Task<IEnumerable<XApiKeyUsageDto>> EnrichRangeAsync(
             IEnumerable<XApiKeyUsageDto> sources,
             CancellationToken cancellationToken = default
         );
@@ -687,7 +689,7 @@ namespace xIds.Interfaces
         /// <param name="sources"></param>
         /// <param name="cancellationToken"></param>
         /// <returns></returns>
-        Task<XApplicationDto> EnrichRangeAsync(
+        Task<IEnumerable<XApplicationDto>> EnrichRangeAsync(
             IEnumerable<XApplicationDto> sources,
             CancellationToken cancellationToken = default
         );

Providers/XApiKeyAuthenticationHandler.cs

@@ -0,0 +1,101 @@
+using System.Linq;
+using IdentityModel;
+using xIds.Interfaces;
+using xCommons.Extensions;
+using System.Threading.Tasks;
+using System.Security.Claims;
+using System.Text.Encodings.Web;
+using xIdentityService.Constants;
+using Microsoft.Extensions.Options;
+using Microsoft.Extensions.Logging;
+using Microsoft.AspNetCore.Authentication;
+
+namespace xIds.Providers
+{
+    /// <summary>
+    /// an Authentication Handler for ApiKey's based App's ...
+    /// </summary>
+    public class XApiKeyAuthenticationHandler : AuthenticationHandler<AuthenticationSchemeOptions>
+    {
+        private readonly IXApplicationProvider applicationProvider;
+
+        //  
+        public string HeaderName { get; } = XHeader.ApiKey.GetStringValue();
+        public string AuthenticationScheme { get; } = XAuthenticationScheme.XApiKey.GetStringValue();
+
+        public XApiKeyAuthenticationHandler(
+            UrlEncoder encoder,
+            ISystemClock clock,
+            ILoggerFactory logger,
+            IXApplicationProvider applicationProvider,
+            IOptionsMonitor<AuthenticationSchemeOptions> options
+        ) : base(options, logger, encoder, clock)
+        {
+            this.applicationProvider = applicationProvider;
+        }
+
+        /// <summary>
+        /// Handle Authentication ...
+        /// </summary>
+        /// <returns></returns>
+        protected override async Task<AuthenticateResult> HandleAuthenticateAsync()
+        {
+            //
+            var apiKey =
+                !Request.Headers.ContainsKey(HeaderName)
+                ? string.Empty
+                : Request.Headers[HeaderName].ToString();
+            if (apiKey.IsNullOrEmpty())
+            {
+                return AuthenticateResult.NoResult();
+            }
+
+            //
+            var clientIP = Request.HttpContext.Connection.RemoteIpAddress?.ToString();
+
+            //
+            var validationResult = await applicationProvider.ValidateApiKey(
+                apiKey: apiKey,
+                clientIP: clientIP
+            );
+            var isValid = !validationResult.Errors.HasChild();
+            if (!isValid)
+            {
+                //
+                var message = validationResult.Errors.ToListString('\n');
+                return AuthenticateResult.Fail(message);
+            }
+
+            //
+            var claims = new[]
+            {
+                new Claim(ClaimTypes.Name, validationResult.OwnerId),
+                new Claim("application_id", validationResult.ApplicationId.ToString()),
+                new Claim("auth_type", "apikey"),
+                new Claim(JwtClaimTypes.Scope, "apikey"),
+            };
+            
+            //
+            var scopeClaims = validationResult.Scopes
+                .Select(s => new Claim(JwtClaimTypes.Scope, s));
+            
+            //
+            var identity = new ClaimsIdentity(
+                claims.Union(scopeClaims), 
+                AuthenticationScheme
+            );
+
+            //
+            var principal = new ClaimsPrincipal(identity);
+            
+            //
+            var ticket = new AuthenticationTicket(
+                principal, 
+                AuthenticationScheme
+            );
+
+            //
+            return AuthenticateResult.Success(ticket);
+        }
+    }
+}

Providers/XApplicationProvider.cs

@@ -13,6 +13,7 @@ using System.Linq.Expressions;
 using IdentityServer4.Extensions;
 using xIdentityModels.Extensions;
 using Microsoft.EntityFrameworkCore.Query;
+using Microsoft.Extensions.Caching.Memory;
 
 namespace xIds.Providers
 {
@@ -21,6 +22,7 @@ namespace xIds.Providers
     /// </summary>
     public partial class XApplicationProvider : IXApplicationProvider
     {
+        private readonly IMemoryCache cache;
         private readonly string permittedRole;
         private readonly XIdentityDbContext dbContext;
         private readonly IXIdentityManager identityManager;
@@ -28,6 +30,7 @@ namespace xIds.Providers
         private readonly XApiKeyConfiguration apiKeyConfiguration;
 
         public XApplicationProvider(
+            IMemoryCache cache,
             XIdentityDbContext dbContext,
             IXIdentityManager identityManager,
             XDataServiceConfiguration configuration,
@@ -36,6 +39,7 @@ namespace xIds.Providers
         )
         {
             //
+            this.cache = cache;
             this.dbContext = dbContext;
             this.permittedRole = permittedRole;
             this.configuration = configuration;
@@ -249,7 +253,7 @@ namespace xIds.Providers
         {
             //
             // Global Result ...
-            var result = dbContext.ApiKeyUsage.AsQueryable();
+            var result = dbContext.ApiKeyUsages.AsQueryable();
 
             //
             // Handle Filtering ...
@@ -276,5 +280,44 @@ namespace xIds.Providers
             // Return result ...
             return result;
         }
+
+        /// <summary>
+        /// Handle Rate Limit Checking ...
+        /// </summary>
+        /// <param name="apiKeyId"></param>
+        /// <param name="limitPerMinute"></param>
+        /// <returns></returns>
+        private bool CheckRateLimit(
+            Guid apiKeyId, 
+            int limitPerMinute
+        )
+        {
+            //
+            var cacheKey = $"ratelimit:{apiKeyId}";
+            var currentCount = cache.GetOrCreate(
+                cacheKey, 
+                entry =>
+                {
+                    //
+                    entry.SlidingExpiration = TimeSpan.FromMinutes(1);
+                    return 0;
+                }
+            );
+
+            //
+            if (currentCount >= limitPerMinute) {
+                return false;
+            }
+
+            //
+            cache.Set(
+                cacheKey, 
+                currentCount + 1, 
+                TimeSpan.FromMinutes(1)
+            );
+
+            //
+            return true;
+        }
     }
 }

Providers/XApplicationProvider/XApplicationProvider+Custom.cs

@@ -8,7 +8,8 @@ using xExceptions.Constants;
 using System.Threading.Tasks;
 using xIdentityModels.Models;
 using System.Collections.Generic;
-using System.Security.Cryptography;
+using xIdentityModels.Extensions;
+using Microsoft.EntityFrameworkCore;
 
 namespace xIds.Providers
 {
@@ -85,7 +86,7 @@ namespace xIds.Providers
 
             //
             // Generate New Key ...
-            (string plainKey, string keyHash, string prefix) = XApiKeyHelper.Generate();
+            (string plainKey, string keyHash, string prefix) = XApiKeyHelper.Generate(apiKeyConfiguration.ApiKeyPrefix);
             var expireAt = DateTime.UtcNow.Add(expiration.Value);
 
             //
@@ -112,7 +113,7 @@ namespace xIds.Providers
             //
             // Add Item to Database ...
             result = await AddApiKeyAsync(
-                item: item,
+                item: result,
                 userInfo: userInfo,
                 cancellationToken: cancellationToken
             );
@@ -323,18 +324,158 @@ namespace xIds.Providers
         /// </summary>
         /// <param name="apiKey"></param>
         /// <param name="clientIP"></param>
+        /// <param name="requiredScope"></param>
         /// <param name="userInfo"></param>
         /// <param name="cancellationToken"></param>
         /// <returns></returns>
-        public async Task<bool> ValidateApiKey(
+        public async Task<XApiKeyValidationResult> ValidateApiKey(
             string apiKey,
             string clientIP,
+            string requiredScope = null,
             XUserClaimsInfoDto userInfo = null,
             CancellationToken cancellationToken = default
         )
         {
             //
+            var result = new XApiKeyValidationResult();
 
+            //
+            // Validate ...
+            var isValid =
+                !apiKey.IsNullOrEmpty() &&
+                !clientIP.IsNullOrEmpty();
+            if (!isValid)
+            {
+                return result;
+            }
+
+            //
+            // Detect Specified Api Key ...
+            var apiKeyHash = XApiKeyHelper.ComputeHash(apiKey);
+            var keyModel = await dbContext.ApiKeys
+                .FirstOrDefaultAsync(
+                    ak => ak.KeyHash == apiKeyHash,
+                    cancellationToken: cancellationToken
+                );
+            isValid = !keyModel.IsNullOrDefault();
+            if (!isValid)
+            {
+                //
+                result.Errors.Add("ApiKey not found ...");
+                return result;
+            }
+
+            //
+            // Here we Have to Parse Allowed Ips and Scopes ...
+            var allowedIps = (keyModel.AllowedIPs ?? string.Empty)
+                .ParseListString<string>();
+            var allowedScopes = (keyModel.AllowedScopes ?? string.Empty)
+                .FromJSON<IEnumerable<string>>();
+            result.Scopes = [..allowedScopes];
+            
+            //
+            // Check Application is Exists and Active ...
+            var application = await dbContext.Applications
+                .FirstOrDefaultAsync(x => x.Id == keyModel.ApplicationId);
+            if (!application.IsNullOrDefault())
+            {
+                result.OwnerId = application.OwnerId;
+                result.ApplicationId = application.Id;
+            }
+
+            //
+            // Check Application is Exists and Active or not ...
+            var isApplicationActive =
+                //
+                // Application Exists ...
+                !application.IsNullOrDefault() &&
+                //
+                // Check Application is Active ...
+                application.IsActive
+                //
+                ;
+            if (!isApplicationActive)
+            {
+                result.Errors.Add("Related Application is Inactive ...");
+            }
+
+            //
+            // Check Key is Active or not ...
+            var isKeyActive =
+                //
+                // Check Api Key is Active ...
+                // Not Revoked ...
+                // Not Expired ...
+                keyModel.IsActive()
+                //
+                ;
+            if (!isKeyActive)
+            {
+                //
+                if (keyModel.IsExpired())
+                {
+                    result.Errors.Add("ApiKey is Expired ...");
+                }
+
+                //
+                if (keyModel.IsRevoked())
+                {
+                    result.Errors.Add("ApiKey is Revoked ...");
+                }
+            }
+
+            //
+            // Checking Rate Limit ...
+            var isRateLimitPassed = CheckRateLimit(keyModel.Id, keyModel.RateLimitPerMinute);
+            if (!isRateLimitPassed)
+            {
+                result.Errors.Add("ApiKey Rate Limit Reached ...");
+            }
+
+            //
+            // Audit Log ...
+
+            //
+            // Check Scope and IP is Valid or not ...
+            var isIpValid =
+                !allowedIps.HasChild() ||
+                    allowedIps.Contains(clientIP);
+            var isScopeValid =
+            !allowedScopes.HasChild() ||
+                    requiredScope.IsNullOrEmpty() ||
+                    allowedScopes.Contains(requiredScope);
+            var isScopeIpValid =
+                isIpValid &&
+                isScopeValid
+                ;
+            if (!isScopeIpValid)
+            {
+                //
+                if (!isIpValid)
+                {
+                    result.Errors.Add("Client IP not Allowed to Use Resource ...");
+                }
+
+                //
+                if (!isScopeValid)
+                {
+                    result.Errors.Add("Required Scoped is Invalid ...");
+                }
+            }
+
+            //
+            isValid =
+                isKeyActive &&
+                isScopeIpValid &&
+                isRateLimitPassed &&
+                isApplicationActive;
+            if (isValid)
+            {
+                result.Errors.Clear();
+            }
+
+            //
+            return result;
         }
         #endregion        
     }

Providers/XApplicationProvider/XApplicationProvider+Enricher.cs

@@ -1,10 +1,11 @@
-using System;
-using System.Collections.Generic;
 using System.Linq;
 using System.Threading;
-using System.Threading.Tasks;
+using xCommons.Extensions;
 using xIdentityModels.Dtos;
+using System.Threading.Tasks;
 using xIdentityModels.Models;
+using System.Collections.Generic;
+using Microsoft.EntityFrameworkCore;
 
 namespace xIds.Providers
 {
@@ -22,7 +23,17 @@ namespace xIds.Providers
             XApiKey source,
             CancellationToken cancellationToken = default
         )
-        { }
+        {
+            //
+            var result = source.MapConvert<XApiKeyDto, XApiKey>();
+            result = await EnrichAsync(
+                source: result,
+                cancellationToken: cancellationToken
+            );
+
+            //
+            return result;
+        }
 
         /// <summary>
         /// Enrich Api Key ...
@@ -34,7 +45,36 @@ namespace xIds.Providers
             XApiKeyDto source,
             CancellationToken cancellationToken = default
         )
-        { }
+        {
+            //
+            if (
+                !source.IsNullOrDefault() &&
+                !source.Application.IsNullOrDefault()
+            )
+            {
+                //
+                var application = await dbContext.Applications
+                    .FirstOrDefaultAsync(
+                        x => x.Id == source.ApplicationId,
+                        cancellationToken: cancellationToken
+                    );
+                if (!application.IsNullOrDefault())
+                {
+                    //
+                    var dto = await EnrichAsync(
+                        source: application,
+                        cancellationToken: cancellationToken
+                    );
+                    if (!dto.IsNullOrDefault())
+                    {
+                        source.Application = dto;
+                    }
+                }
+            }
+
+            //
+            return source;
+        }
 
         /// <summary>
         /// Enrich Api Key Usage ...
@@ -46,7 +86,17 @@ namespace xIds.Providers
             XApiKeyUsage source,
             CancellationToken cancellationToken = default
         )
-        { }
+        {
+            //
+            var result = source.MapConvert<XApiKeyUsageDto, XApiKeyUsage>();
+            result = await EnrichAsync(
+                source: result,
+                cancellationToken: cancellationToken
+            );
+
+            //
+            return result;
+        }
 
         /// <summary>
         /// Enrich Application ...
@@ -58,7 +108,17 @@ namespace xIds.Providers
             XApplication source,
             CancellationToken cancellationToken = default
         )
-        { }
+        {
+            //
+            var result = source.MapConvert<XApplicationDto, XApplication>();
+            result = await EnrichAsync(
+                source: result,
+                cancellationToken: cancellationToken
+            );
+
+            //
+            return result;
+        }
 
         /// <summary>
         /// Enrich Api Key Usage ...
@@ -70,7 +130,12 @@ namespace xIds.Providers
             XApiKeyUsageDto source,
             CancellationToken cancellationToken = default
         )
-        { }
+        {
+            //
+            // There is not any Additional Enrichment ...
+            var result = await Task.FromResult(source);
+            return result;
+        }
 
         /// <summary>
         /// Enrich Application ...
@@ -82,7 +147,24 @@ namespace xIds.Providers
             XApplicationDto source,
             CancellationToken cancellationToken = default
         )
-        { }
+        {
+            //
+            if (
+                !source.IsNullOrDefault() &&
+                !source.OwnerId.IsNullOrEmpty()
+            )
+            {
+                //
+                var owner = await GetOwner(source.OwnerId);
+                if (!owner.IsNullOrDefault())
+                {
+                    source.Owner = owner;
+                }
+            }
+
+            //
+            return source;
+        }
 
         /// <summary>
         /// Enrich a Collection of Api Key(s) ...
@@ -94,7 +176,17 @@ namespace xIds.Providers
             IEnumerable<XApiKey> sources,
             CancellationToken cancellationToken = default
         )
-        { }
+        {
+            //
+            var tasks = sources
+                .Select(s => EnrichAsync(s, cancellationToken));
+
+            //
+            var result = await Task.WhenAll(tasks);
+
+            //
+            return result;
+        }
 
         /// <summary>
         /// Enrich a Collection of Api Key(s) ...
@@ -106,7 +198,17 @@ namespace xIds.Providers
             IEnumerable<XApiKeyDto> sources,
             CancellationToken cancellationToken = default
         )
-        { }
+        {
+            //
+            var tasks = sources
+                .Select(s => EnrichAsync(s, cancellationToken));
+
+            //
+            var result = await Task.WhenAll(tasks);
+
+            //
+            return result;
+        }
 
         /// <summary>
         /// Enrich a Collection of Api Key Usage(s) ...
@@ -118,7 +220,17 @@ namespace xIds.Providers
             IEnumerable<XApiKeyUsage> sources,
             CancellationToken cancellationToken = default
         )
-        { }
+        {
+            //
+            var tasks = sources
+                .Select(s => EnrichAsync(s, cancellationToken));
+
+            //
+            var result = await Task.WhenAll(tasks);
+
+            //
+            return result;
+        }
 
         /// <summary>
         /// Enrich a Collection of Application(s) ...
@@ -130,7 +242,17 @@ namespace xIds.Providers
             IEnumerable<XApplication> sources,
             CancellationToken cancellationToken = default
         )
-        { }
+        {
+            //
+            var tasks = sources
+                .Select(s => EnrichAsync(s, cancellationToken));
+
+            //
+            var result = await Task.WhenAll(tasks);
+
+            //
+            return result;
+        }
 
         /// <summary>
         /// Enrich a Collection of Api Key Usage(s) ...
@@ -142,7 +264,17 @@ namespace xIds.Providers
             IEnumerable<XApiKeyUsageDto> sources,
             CancellationToken cancellationToken = default
         )
-        { }
+        {
+            //
+            var tasks = sources
+                .Select(s => EnrichAsync(s, cancellationToken));
+
+            //
+            var result = await Task.WhenAll(tasks);
+
+            //
+            return result;
+        }
 
         /// <summary>
         /// Enrich a Collection of Application(s) ...
@@ -154,7 +286,17 @@ namespace xIds.Providers
             IEnumerable<XApplicationDto> sources,
             CancellationToken cancellationToken = default
         )
-        { }
+        {
+            //
+            var tasks = sources
+                .Select(s => EnrichAsync(s, cancellationToken));
+
+            //
+            var result = await Task.WhenAll(tasks);
+
+            //
+            return result;
+        }
         #endregion
     }
 }

Startup.cs

@@ -1,20 +1,20 @@
 using System;
+using xIds.DI;
 using System.IO;
+using xIds.Constants;
+using xIds.Providers;
+using Newtonsoft.Json;
+using xIds.Interfaces;
 using System.Reflection;
+using xStorageService.DI;
+using xCommons.Extensions;
+using xCommons.Configurations;
 using Microsoft.AspNetCore.Builder;
 using Microsoft.AspNetCore.Hosting;
-using Microsoft.Extensions.Configuration;
-using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Hosting;
 using Microsoft.Extensions.Logging;
-using Newtonsoft.Json;
+using Microsoft.Extensions.Configuration;
-using xCommons.Configurations;
+using Microsoft.Extensions.DependencyInjection;
-using xCommons.Extensions;
-using xStorageService.DI;
-using xIds.Constants;
-using xIds.DI;
-using xIds.Interfaces;
-using xIds.Providers;
 
 namespace xIds
 {
@@ -57,6 +57,10 @@ namespace xIds
             // services.AddInMemoryXIdentityServer (Configuration);
             services.AddEfSupportXIdentityServer(Configuration);
 
+            //
+            // Services Application and Api Key Management Services ...
+            services.AddXApplicationProvider(Configuration);
+
             //
             services.AddControllers()
                 .AddNewtonsoftJson(x => x.SerializerSettings.ReferenceLoopHandling = ReferenceLoopHandling.Ignore);

appsettings.Development.json

@@ -37,6 +37,7 @@
     "MaxFileSize": 41943040
   },
   "ApiKeyConfiguration": {
+    "ApiPrefix": "xapp",
     "DefaultRateLimit": 60,
     "EnableAuditLog": false,
     "MaxKeysPerApplication": "10",

xIds.csproj

@@ -36,6 +36,7 @@
   <!-- Project Dependencies -->
   <ItemGroup>
     <ProjectReference Include="..\Modules\xIdentityHelper\xIdentityHelper.csproj" />
+    <ProjectReference Include="..\Modules\xIdentityService\xIdentityService.csproj" />
   </ItemGroup>
 
   <!-- IdentityServer -->