Compare commits

...
2 Commits
Author SHA1 Message Date
saherelm 2e8f269ae6 last ... 2026-10-09 19:35:50 +03:30
saherelm c4e430a98f last ... 2026-10-09 14:20:47 +03:30
5 changed files with 297 additions and 35 deletions
@@ -1,4 +1,5 @@
using System; using System;
using System.Linq;
using xIdentityHelper; using xIdentityHelper;
using System.Threading; using System.Threading;
using xCommons.Attributes; using xCommons.Attributes;
@@ -17,6 +18,13 @@ namespace xIds.Controllers
{ {
public partial class ApplicationsController public partial class ApplicationsController
{ {
/// <summary>
/// Create Api Key ...
/// </summary>
/// <param name="applicationId"></param>
/// <param name="request"></param>
/// <param name="cancellationToken"></param>
/// <returns></returns>
[RequireXPowered] [RequireXPowered]
[Authorize(LocalApi.PolicyName)] [Authorize(LocalApi.PolicyName)]
[Authorize(Policy = XPolicies.EnabledUser)] [Authorize(Policy = XPolicies.EnabledUser)]
@@ -56,14 +64,34 @@ namespace xIds.Controllers
} }
// //
// Create Specified Api Key ... // Noramlize TimeSpan ...
var expirationTimeSpan = TimeSpan
.FromMinutes(apiKeyConfiguration.DefaultExpirationMinutes);
if (
request.ExpirationMinutes.HasValue &&
request.ExpirationMinutes.Value > 0
)
{
//
// Normalize Expiration Minutes ...
int minutes = request.ExpirationMinutes.Value;
if (minutes > apiKeyConfiguration.MaxExpirationMinutes)
{
minutes = apiKeyConfiguration.MaxExpirationMinutes;
}
//
expirationTimeSpan = TimeSpan.FromMinutes(minutes);
}
//
var result = await provider.CreateApiKey( var result = await provider.CreateApiKey(
userInfo: userInfo, userInfo: userInfo,
scopes: request.Scopes, scopes: request.Scopes,
applicationId: applicationId, applicationId: applicationId,
rateLimit: request.RateLimit, rateLimit: request.RateLimit,
allowedIPs: request.AllowedIPs, allowedIPs: request.AllowedIPs,
expiration: request.Expiration, expiration: expirationTimeSpan,
cancellationToken: cancellationToken cancellationToken: cancellationToken
); );
@@ -78,6 +106,13 @@ namespace xIds.Controllers
} }
} }
/// <summary>
/// Remove Specified Api Key ...
/// </summary>
/// <param name="apiKeyId"></param>
/// <param name="applicationId"></param>
/// <param name="cancellationToken"></param>
/// <returns></returns>
[RequireXPowered] [RequireXPowered]
[Authorize(LocalApi.PolicyName)] [Authorize(LocalApi.PolicyName)]
[Authorize(Policy = XPolicies.EnabledUser)] [Authorize(Policy = XPolicies.EnabledUser)]
@@ -117,7 +152,6 @@ namespace xIds.Controllers
} }
// //
// Create Specified Api Key ...
var result = await provider.RemoveApiKeyAsync( var result = await provider.RemoveApiKeyAsync(
id: apiKeyId, id: apiKeyId,
softDelete: false, softDelete: false,
@@ -136,6 +170,14 @@ namespace xIds.Controllers
} }
} }
/// <summary>
/// Rotate Specified Api Key ...
/// </summary>
/// <param name="apiKeyId"></param>
/// <param name="applicationId"></param>
/// <param name="request"></param>
/// <param name="cancellationToken"></param>
/// <returns></returns>
[RequireXPowered] [RequireXPowered]
[Authorize(LocalApi.PolicyName)] [Authorize(LocalApi.PolicyName)]
[Authorize(Policy = XPolicies.EnabledUser)] [Authorize(Policy = XPolicies.EnabledUser)]
@@ -192,7 +234,6 @@ namespace xIds.Controllers
} }
// //
// Create Specified Api Key ...
var result = await provider.RotateApiKey( var result = await provider.RotateApiKey(
apiKeyId: apiKeyId, apiKeyId: apiKeyId,
userInfo: userInfo, userInfo: userInfo,
@@ -211,19 +252,75 @@ namespace xIds.Controllers
} }
} }
/// <summary>
/// Revoke Specified Api Key ...
/// </summary>
/// <param name="apiKeyId"></param>
/// <param name="applicationId"></param>
/// <param name="cancellationToken"></param>
/// <returns></returns>
[RequireXPowered] [RequireXPowered]
[Authorize(LocalApi.PolicyName)] [Authorize(LocalApi.PolicyName)]
[Authorize(Policy = XPolicies.EnabledUser)] [Authorize(Policy = XPolicies.EnabledUser)]
[HttpPost("Applications/{applicationId}/ApiKeys/{apiKeyId}/Revoke")] [HttpPost("Applications/{applicationId}/ApiKeys/{apiKeyId}/Revoke")]
public async Task<ActionResult<XApiKeyDto>> RevokeApiKey( public async Task<ActionResult<bool>> RevokeApiKey(
[FromRoute] Guid apiKeyId, [FromRoute] Guid apiKeyId,
[FromRoute] int applicationId, [FromRoute] int applicationId,
CancellationToken cancellationToken = default CancellationToken cancellationToken = default
) )
{ {
throw new NotImplementedException(); //
try
{
//
// Validate ...
if (
apiKeyId.IsDefaultGuid() ||
!applicationId.IsValidIntId())
{
XException.InvalidArgs.Throw();
}
//
var userInfo = await GetUserInfo();
//
// Retrieve Application for Validating ...
var application = await provider.GetApplicationAsync(
id: applicationId,
userInfo: userInfo,
includeBuilder: null,
ignoreSoftDeleteds: true
);
if (application.IsNullOrDefault())
{
XException.NotFound.Throw();
}
//
var result = await provider.RevokeApiKey(
apiKeyId: apiKeyId,
userInfo: userInfo,
cancellationToken: cancellationToken
);
//
return Ok(result);
}
catch (Exception ex)
{
//
var result = GetExceptionActionResult(ex);
return result;
}
} }
/// <summary>
/// Retrieve Specified Application's Api Keys ...
/// </summary>
/// <param name="applicationId"></param>
/// <param name="cancellationToken"></param>
/// <returns></returns>
[RequireXPowered] [RequireXPowered]
[Authorize(LocalApi.PolicyName)] [Authorize(LocalApi.PolicyName)]
[Authorize(Policy = XPolicies.EnabledUser)] [Authorize(Policy = XPolicies.EnabledUser)]
@@ -233,33 +330,176 @@ namespace xIds.Controllers
CancellationToken cancellationToken = default CancellationToken cancellationToken = default
) )
{ {
throw new NotImplementedException(); //
try
{
//
// Validate ...
if (!applicationId.IsValidIntId())
{
XException.InvalidArgs.Throw();
}
//
var userInfo = await GetUserInfo();
//
// Retrieve Application for Validating ...
var application = await provider.GetApplicationAsync(
id: applicationId,
userInfo: userInfo,
includeBuilder: null,
ignoreSoftDeleteds: true
);
if (application.IsNullOrDefault())
{
XException.NotFound.Throw();
}
//
var result = await provider.GetApplicationApiKeys(
userInfo: userInfo,
applicationId: applicationId,
cancellationToken: cancellationToken
);
//
return Ok(result.ToDynamicObject());
}
catch (Exception ex)
{
//
var result = GetExceptionActionResult(ex);
return result;
}
} }
/// <summary>
/// Retrieve Specified Api Keys Usages ...
/// </summary>
/// <param name="apiKeyId"></param>
/// <param name="applicationId"></param>
/// <param name="cancellationToken"></param>
/// <returns></returns>
[RequireXPowered] [RequireXPowered]
[Authorize(LocalApi.PolicyName)] [Authorize(LocalApi.PolicyName)]
[Authorize(Policy = XPolicies.EnabledUser)] [Authorize(Policy = XPolicies.EnabledUser)]
[HttpPost("Applications/{applicationId}/ApiKeys/{apiKeyId}/Usages")] [HttpPost("Applications/{applicationId}/ApiKeys/{apiKeyId}/Usages")]
public async Task<ActionResult<XApiKeyDto>> GetApiKeyUsages( public async Task<ActionResult<IEnumerable<XApiKeyUsageDto>>> GetApiKeyUsages(
[FromRoute] Guid apiKeyId, [FromRoute] Guid apiKeyId,
[FromRoute] int applicationId, [FromRoute] int applicationId,
CancellationToken cancellationToken = default CancellationToken cancellationToken = default
) )
{ {
throw new NotImplementedException(); //
} try
{
[RequireXPowered] //
[Authorize(LocalApi.PolicyName)] // Validate ...
[HttpPost("Applications/{applicationId}/ApiKeys/{apiKeyId}/Validate")] if (
public async Task<ActionResult<XApiKeyDto>> ValidateApiKey( apiKeyId.IsDefaultGuid() ||
[FromRoute] Guid apiKeyId, !applicationId.IsValidIntId())
[FromRoute] int applicationId, {
CancellationToken cancellationToken = default XException.InvalidArgs.Throw();
) }
{
throw new NotImplementedException(); //
var userInfo = await GetUserInfo();
//
// Retrieve Application for Validating ...
var application = await provider.GetApplicationAsync(
id: applicationId,
userInfo: userInfo,
includeBuilder: null,
ignoreSoftDeleteds: true
);
if (application.IsNullOrDefault())
{
XException.NotFound.Throw();
}
//
// Retrieve ApiKey for Validating ...
var apiKey = await provider.GetApiKeyAsync(
id: apiKeyId,
userInfo: userInfo,
includeBuilder: null,
ignoreSoftDeleteds: true
);
if (application.IsNullOrDefault())
{
XException.NotFound.Throw();
}
//
var result = await provider.FindManyApiKeyUsageAsync(
userInfo: userInfo,
includeBuilder: null,
ignoreSoftDeleteds: true,
cancellationToken: cancellationToken,
predicate: x => x.ApiKeyId == apiKeyId,
orderBuilder: x => x.OrderBy(y => y.RequestedOn)
);
//
return Ok(result.ToDynamicObject());
}
catch (Exception ex)
{
//
var result = GetExceptionActionResult(ex);
return result;
}
} }
/// <summary>
/// Validate Specifed Api Key ...
/// </summary>
/// <param name="request"></param>
/// <param name="cancellationToken"></param>
/// <returns></returns>
[RequireXPowered]
[Authorize(LocalApi.PolicyName)]
[HttpPost("Applications/ApiKeys/Validate")]
public async Task<ActionResult<XApiKeyValidationResult>> ValidateApiKey(
[FromBody] XApiKeyValidationRequest request,
CancellationToken cancellationToken = default
)
{
//
try
{
//
// Validate ...
await ValidationProvider
.GroupValidationBuilder()
.AddNotNull(request)
.AddNotEmpty(request.ApiKey)
.AddNotEmpty(request.ClientIP)
.ValidateGroupAsync();
//
var userInfo = await GetUserInfo();
//
var result = await provider.ValidateApiKey(
userInfo: userInfo,
apiKey: request.ApiKey,
clientIP: request.ClientIP,
requiredScope: request.RequiredScope,
cancellationToken: cancellationToken
);
//
return Ok(result.ToDynamicObject());
}
catch (Exception ex)
{
//
var result = GetExceptionActionResult(ex);
return result;
}
}
} }
} }
+25 -5
View File
@@ -14,6 +14,7 @@ using IdentityServer4.Extensions;
using xIdentityModels.Extensions; using xIdentityModels.Extensions;
using Microsoft.EntityFrameworkCore.Query; using Microsoft.EntityFrameworkCore.Query;
using Microsoft.Extensions.Caching.Memory; using Microsoft.Extensions.Caching.Memory;
using AutoMapper;
namespace xIds.Providers namespace xIds.Providers
{ {
@@ -28,6 +29,7 @@ namespace xIds.Providers
private readonly IXIdentityManager identityManager; private readonly IXIdentityManager identityManager;
private readonly XDataServiceConfiguration configuration; private readonly XDataServiceConfiguration configuration;
private readonly XApiKeyConfiguration apiKeyConfiguration; private readonly XApiKeyConfiguration apiKeyConfiguration;
private readonly Action<IMapperConfigurationExpression> mapperConfigurationExp;
public XApplicationProvider( public XApplicationProvider(
IMemoryCache cache, IMemoryCache cache,
@@ -45,6 +47,23 @@ namespace xIds.Providers
this.configuration = configuration; this.configuration = configuration;
this.identityManager = identityManager; this.identityManager = identityManager;
this.apiKeyConfiguration = apiKeyConfiguration; this.apiKeyConfiguration = apiKeyConfiguration;
//
// Configure Mapper Options ...
mapperConfigurationExp = cfg =>
{
//
cfg.CreateMap<XApiKey, XApiKeyDto>()
.ReverseMap();
//
cfg.CreateMap<XApplication, XApplicationDto>()
.ReverseMap();
//
cfg.CreateMap<XApiKeyUsage, XApiKeyUsageDto>()
.ReverseMap();
};
} }
/// <summary> /// <summary>
@@ -288,14 +307,14 @@ namespace xIds.Providers
/// <param name="limitPerMinute"></param> /// <param name="limitPerMinute"></param>
/// <returns></returns> /// <returns></returns>
private bool CheckRateLimit( private bool CheckRateLimit(
Guid apiKeyId, Guid apiKeyId,
int limitPerMinute int limitPerMinute
) )
{ {
// //
var cacheKey = $"ratelimit:{apiKeyId}"; var cacheKey = $"ratelimit:{apiKeyId}";
var currentCount = cache.GetOrCreate( var currentCount = cache.GetOrCreate(
cacheKey, cacheKey,
entry => entry =>
{ {
// //
@@ -305,14 +324,15 @@ namespace xIds.Providers
); );
// //
if (currentCount >= limitPerMinute) { if (currentCount >= limitPerMinute)
{
return false; return false;
} }
// //
cache.Set( cache.Set(
cacheKey, cacheKey,
currentCount + 1, currentCount + 1,
TimeSpan.FromMinutes(1) TimeSpan.FromMinutes(1)
); );
@@ -25,7 +25,7 @@ namespace xIds.Providers
) )
{ {
// //
var result = source.MapConvert<XApiKeyDto, XApiKey>(); var result = source.MapConvert<XApiKeyDto, XApiKey>(mapperConfigurationExp);
result = await EnrichAsync( result = await EnrichAsync(
source: result, source: result,
cancellationToken: cancellationToken cancellationToken: cancellationToken
@@ -88,7 +88,7 @@ namespace xIds.Providers
) )
{ {
// //
var result = source.MapConvert<XApiKeyUsageDto, XApiKeyUsage>(); var result = source.MapConvert<XApiKeyUsageDto, XApiKeyUsage>(mapperConfigurationExp);
result = await EnrichAsync( result = await EnrichAsync(
source: result, source: result,
cancellationToken: cancellationToken cancellationToken: cancellationToken
@@ -110,7 +110,7 @@ namespace xIds.Providers
) )
{ {
// //
var result = source.MapConvert<XApplicationDto, XApplication>(); var result = source.MapConvert<XApplicationDto, XApplication>(mapperConfigurationExp);
result = await EnrichAsync( result = await EnrichAsync(
source: result, source: result,
cancellationToken: cancellationToken cancellationToken: cancellationToken
+4 -4
View File
@@ -37,12 +37,12 @@
"MaxFileSize": 41943040 "MaxFileSize": 41943040
}, },
"ApiKeyConfiguration": { "ApiKeyConfiguration": {
"ApiPrefix": "xapp", "ApiKeyPrefix": "xapp",
"DefaultRateLimit": 60, "DefaultRateLimit": 60,
"EnableAuditLog": false, "EnableAuditLog": false,
"MaxKeysPerApplication": "10", "MaxKeysPerApplication": 10,
"MaxExpirationMinutes": "525600", "MaxExpirationMinutes": 525600,
"DefaultExpirationMinutes": "43200" "DefaultExpirationMinutes": 43200
}, },
"DbSeeder": { "DbSeeder": {
"UpdateExists": false, "UpdateExists": false,
+4 -2
View File
@@ -29,13 +29,15 @@
<!-- Local Dependencies --> <!-- Local Dependencies -->
<ItemGroup> <ItemGroup>
<PackageReference Include="xDashboard.xMessageService" Version="1.0.0" /> <!-- <PackageReference Include="xDashboard.xMessageService" Version="1.0.0" />
<PackageReference Include="xDashboard.xStorageService" Version="1.0.0" /> <PackageReference Include="xDashboard.xStorageService" Version="1.0.0" /> -->
</ItemGroup> </ItemGroup>
<!-- Project Dependencies --> <!-- Project Dependencies -->
<ItemGroup> <ItemGroup>
<ProjectReference Include="..\Modules\xIdentityHelper\xIdentityHelper.csproj" /> <ProjectReference Include="..\Modules\xIdentityHelper\xIdentityHelper.csproj" />
<ProjectReference Include="..\Modules\xMessageService\xMessageService.csproj" />
<ProjectReference Include="..\Modules\xStorageService\xStorageService.csproj" />
<ProjectReference Include="..\Modules\xIdentityService\xIdentityService.csproj" /> <ProjectReference Include="..\Modules\xIdentityService\xIdentityService.csproj" />
</ItemGroup> </ItemGroup>