Rozšíření oprávnění
Oprávnění jsou důležitým prvkem zabezpečení prostředků aplikace. S jejich pomocí můžete omezit přístup k určité části aplikace, nebo naopak poskytnout potřebná práva ke čtení/změně konkrétní oblasti.
Všechna dostupná oprávnění pro řízení rozsahu najdete v sekci Seznam řízení přístupu (ACL).
Stejně jako jakékoli jiné změny v aplikaci se doporučuje provádět je prostřednictvím pluginů. Podívejme se tedy na přidání oprávnění pomocí abstraktního pluginu. Cílem tohoto návodu je ukázat, jak spravovat oprávnění; informace o vytvoření samotného pluginu najdete na této stránce.
Přidání vlastního oprávnění v nopCommerce 4.80 a novějších
Nejprve vytvořme třídu, která popisuje nové oprávnění – bude to poskytovatel oprávnění. Je nutné a postačující, aby tato třída dědila z rozhraní IPermissionConfigManager.
public partial class WebApiBackendPermissionConfigManager : IPermissionConfigManager
{
public const string ACCESS_WEB_API = "AccessWebApi";
/// <summary>
/// Gets all permission configurations
/// </summary>
public IList<PermissionConfig> AllConfigs =>
new List<PermissionConfig>
{
new("Access Web API Backend", ACCESS_WEB_API , nameof(StandardPermission.System), NopCustomerDefaults.AdministratorsRoleName)
};
}
Zadané záznamy se do databáze nainstalují bez jakýchkoli dalších kroků.
V tomto příkladu je oprávnění nastaveno pouze pro roli administrátora, ale v případě potřeby lze tento seznam rozšířit.
Nezapomeňte oprávnění při odebírání pluginu také odstranit v metodě UninstallAsync():
//delete permission
var permissionRecord = (await _permissionService.GetAllPermissionRecordsAsync())
.FirstOrDefault(x => x.SystemName == WebApiBackendPermissionConfigManager.ACCESS_WEB_API);
await _permissionService.DeletePermissionRecordAsync(permissionRecord);
Nyní na každém místě, kde potřebujeme ověřit oprávněnost přístupu uživatele ke konkrétnímu prostředku, musíme zavolat metodu AuthorizeAsync() služby IPermissionService s daným oprávněním:
//check whether current customer has access to Web API
if (await _permissionService.AuthorizeAsync(WebApiBackendPermissionConfigManager.ACCESS_WEB_API))
return;
Další způsob použití oprávnění, a to jako atributu filtru akce controlleru, je následující:
[CheckPermission(WebApiBackendPermissionConfigManager.ACCESS_WEB_API)]
public virtual async Task<IActionResult> Configure()
{
...
}
To je v podstatě vše – po instalaci pluginu uvidíte přidané oprávnění v sekci ACL.
Poznámka
Pokud chcete použít výchozí vestavěná oprávnění, všechna jsou uvedena ve třídě StandardPermission (jmenný prostor Nop.Services.Security).
Například:
[CheckPermission(StandardPermission.Configuration.MANAGE_SETTINGS)]
Přidání vlastního oprávnění v nopCommerce 4.70 a starších
Nejprve vytvořme třídu, která popisuje nové oprávnění – bude to poskytovatel oprávnění. Je nutné a postačující, aby tato třída dědila z rozhraní IPermissionProvider.
public partial class WebApiBackendPermissionProvider : IPermissionProvider
{
public static readonly PermissionRecord AccessWebApiBackend = new ()
{
Name = "Access Web API Backend", SystemName = "AccessWebApi", Category= "Standard"
};
/// <summary>
/// Get permissions
/// </summary>
/// <returns>Permissions</returns>
public virtual IEnumerable<PermissionRecord> GetPermissions()
{
return new[]
{
AccessWebApiBackend
};
}
/// <summary>
/// Get default permissions
/// </summary>
/// <returns>Permissions</returns>
public virtual HashSet<(string systemRoleName, PermissionRecord[]permissions)> GetDefaultPermissions()
{
return new () { (NopCustomerDefaults.AdministratorsRoleName, new [] { AccessWebApiBackend }) };
}
}
V tomto příkladu je oprávnění nastaveno pouze pro roli administrátora, ale v případě potřeby lze tento seznam rozšířit.
Nyní toto oprávnění přidáme při instalaci našeho pluginu. To je nutné provést v metodě InstallAsync():
//add permission
await _permissionService.InstallPermissionsAsync(new WebApiBackendPermissionProvider());
Nezapomeňte oprávnění při odebírání pluginu také odstranit v metodě UninstallAsync():
//delete permission
var permissionRecord = (await _permissionService.GetAllPermissionRecordsAsync())
.FirstOrDefault(x => x.SystemName == WebApiBackendPermissionProvider.AccessWebApiBackend.SystemName);
var listMappingCustomerRolePermissionRecord = await _permissionService.GetMappingByPermissionRecordIdAsync(permissionRecord.Id);
foreach (var mappingCustomerPermissionRecord in listMappingCustomerRolePermissionRecord)
await _permissionService.DeletePermissionRecordCustomerRoleMappingAsync(
mappingCustomerPermissionRecord.PermissionRecordId,
mappingCustomerPermissionRecord.CustomerRoleId);
await _permissionService.DeletePermissionRecordAsync(permissionRecord);
Nyní na každém místě, kde potřebujeme ověřit oprávněnost přístupu uživatele ke konkrétnímu prostředku, musíme zavolat metodu AuthorizeAsync() služby IPermissionService s daným oprávněním:
//check whether current customer has access to Web API
if (await _permissionService.AuthorizeAsync(WebApiBackendPermissionProvider.AccessWebApiBackend))
return;
To je v podstatě vše – po instalaci pluginu uvidíte přidané oprávnění v sekci ACL.