SecurityStrategyComplex Class

A Security Strategy that maintains users who have a list of associated roles.

Namespace: DevExpress.ExpressApp.Security

Assembly: DevExpress.ExpressApp.Security.v23.2.dll

NuGet Package: DevExpress.ExpressApp.Security

Declaration

C#
VB.NET

[ToolboxTabName("DX.23.2: XAF Security")]
public class SecurityStrategyComplex :
    SecurityStrategy,
    ISecurityComplex,
    ISecurityStrategyBase,
    IRoleTypeProvider,
    IServiceProviderContainer

<ToolboxTabName("DX.23.2: XAF Security")>
Public Class SecurityStrategyComplex
    Inherits SecurityStrategy
    Implements ISecurityComplex,
               ISecurityStrategyBase,
               IRoleTypeProvider,
               IServiceProviderContainer

C#
VB.NET

[ToolboxTabName("DX.23.2: XAF Security")]
public class SecurityStrategyComplex :
    SecurityStrategy,
    ISecurityComplex,
    ISecurityStrategyBase,
    IRoleTypeProvider

<ToolboxTabName("DX.23.2: XAF Security")>
Public Class SecurityStrategyComplex
    Inherits SecurityStrategy
    Implements ISecurityComplex,
               ISecurityStrategyBase,
               IRoleTypeProvider

Remarks

In the SecurityStrategyComplex security strategy, each user can belong to one or more groups. These groups are called Roles (see XPO PermissionPolicyRole or EF Core PermissionPolicyRole). Roles are characterized by an associated permission set. An application administrator creates users and roles, and assigns roles to users. An application developer can create a set of predefined users and roles that can be extended later by an administrator (see Client-Side Security (2-Tier Architecture)).

Note

To see what capabilities are provided to an administrator within the SecurityStrategyComplex security strategy, refer to the Security System Overview topic.

By default, a newly created XAF application uses no security. To enable to the SecurityStrategyComplex security strategy, invoke the Application Designer and drag the SecurityStrategyComplex component from the ToolBox‘s DX.23.2: XAF Security page to the designer’s Security pane.

Security_UseSecurityStrategyComplex

You can specify a custom user and role type by changing the SecurityStrategy.UserType and SecurityStrategyComplex.RoleType values in the Properties window.

Security_SetCustomUserType

Then, specify the authentication type that will accompany the security strategy. Drag either the AuthenticationStandard or AuthenticationActiveDirectory component from the toolbox to the Security pane of the designer. You can also use a custom authentication (see Customize Standard Authentication Behavior and Supply Additional Logon Parameters (Blazor)).

Security_DesignerAuthenticationSimple

Alternatively, you can enable the SecurityStrategyComplex Security Strategy in code. It is required to instantiate the SecurityStrategyComplex class and assign this instance to the XafApplication.Security property. In a Windows Forms application project, modify the Program.cs (Program.vb) file in the following manner.

C#
VB.NET

public static void Main(string[] arguments) {
    MySolutionWinApplication winApplication = new MySolutionWinApplication();
    winApplication.Security = 
        new SecurityStrategyComplex(typeof(PermissionPolicyUser), typeof(PermissionPolicyRole), 
            new AuthenticationStandard());
    // ...
}

Public Shared Sub Main(ByVal arguments() As String)
    Dim winApplication As New MySolutionWinApplication()
    winApplication.Security = _
    New SecurityStrategyComplex( _
    GetType(PermissionPolicyUser), GetType(PermissionPolicyRole), New AuthenticationStandard())
    ' ...
End Sub

In an ASP.NET Web Forms application project, modify the Global.asax.cs (Global.asax.vb) file in the following manner.

C#
VB.NET

protected void Session_Start(Object sender, EventArgs e) {
    WebApplication.SetInstance(Session, new MySolutionAspNetApplication());
    WebApplication.Instance.Security = 
       new SecurityStrategyComplex(typeof(PermissionPolicyUser), typeof(PermissionPolicyRole), 
            new AuthenticationStandard());

    // ...
}

Protected Sub Session_Start(ByVal sender As Object, ByVal e As EventArgs)
    WebApplication.SetInstance(Session, New MySolutionAspNetApplication())
    WebApplication.Instance.Security = _
    New SecurityStrategyComplex( _
    GetType(PermissionPolicyUser), GetType(PermissionPolicyRole), New AuthenticationStandard())
    ' ...
End Sub

As a result, in a WinForms application you can see the User, Role and My Details navigation items. The active user name is displayed in the status bar. Tutorial_Security_ActiveDir