This chapter includes the following sections:
Overview of Securing WebLogic Resources
To secure a resource in a WebLogic Server domain, you create a policy and an optional role. A resource is an entity (such as a Web Service or a server instance) or an action (such as a method in a Web Service or the act of shutting down a server instance). A policy specifies which users, groups, or roles can access the resource under a set of conditions. A security role, like a security group, grants an identity to a user. Unlike a group, however, membership in a role can be based on a set of conditions that are evaluated at run time.
Note:The Java EE Security API (JSR 375) requires that group principal names are mapped to roles of the same name by default. In WebLogic Server, if the
security-role-assignmentelement in the
weblogic.xmldeployment descriptor does not declare a mapping between a security role and one or more principals in the WebLogic Server security realm, then the role name is used as the default principal.
Figure 2-1 describes how you create roles and policies and how the Security Service uses them to determine whether a client can access a resource. A brief explanation follows the figure.
Figure 2-1 How a Policy Grants Access to a Resource
Description of "Figure 2-1 How a Policy Grants Access to a Resource"
Before creating security policies and roles, Administrators statically assign users to groups, which can represent organizational boundaries. The same user can be a member of multiple groups. Figure 2-1 shows three groups with two users each. User 1 and User 3 are members of multiple groups.
Oracle recommends assigning users to groups because doing so increases efficiency for administrators who work with many users.
Administrators create a security role based on their organization's established business procedures. The security role consists of one or more conditions, which specify the circumstances under which a particular user, group, or other role should be granted the security role.
At run time, the Security Service compares the groups against the role condition(s) to determine whether users in the group should be dynamically granted a security role. This process of comparing groups to roles is called role mapping. In Figure 2-1, Group 2 is the only group that is granted a security role.
Individual users can also be granted a security role, but this is a less typical practice.
Administrators create a security policy based on their organization's established business procedures. The security policy consists of one or more policy conditions which specify the circumstances under which a particular security role should be granted access to a WebLogic resource.
At run time, the WebLogic Security Service uses the security policy to determine whether access to the protected WebLogic resource should be granted. Only users who are members of the group that is granted the security role can access the WebLogic resource. In Figure 2-1, User 3 and User 6 can access the protected WebLogic resource because they are members of Group 2, and Group 2 is granted the necessary security role.
Using Policies to Protect Multiple Resources
WebLogic Server provides two techniques for using a single policy to protect a collection of resources, described in the following sections:
Protecting Policies by Type
You can create a policy that protects all resources of a specific type. Such policies are called root-level policies. For example, you can create a root-level policy for the Web Service type. All Web Services that you deploy in the domain for which you have defined this root-level policy will be protected by the root-level policy.
If you define a policy for a specific Web Service, then the Web Service will be protected by its own policy and will ignore the root-level policy.
Protecting a Hierarchy of Resources
All of the resources within a Java EE application or module that you deploy exist within a hierarchy, and policies on resources higher in the hierarchy act as default policies for resources lower in the same hierarchy. Policies lower in a hierarchy always override policies higher in the hierarchy.
For example, EnterpriseApp1contains EJB ModuleA along with a Web application and a JDBC module (see Figure 2-2). You create a policy for EnterpriseApp1 and for method Y within EJB ModuleA. When an EJB client attempts to invoke method Y, the WebLogic Security Service enforces the specific policy and ignores the policy for the enterprise application.
When a client requests access to EJB method X (which is not protected by its own policy), the WebLogic Security Service asks:
Is there a policy for this EJB method? No, therefore go to the next higher level in the hierarchy.
Is there a policy for the EJB that contains this method? No, therefore go to the next higher level in the hierarchy.
Is there a policy for the EJB module that contains the method's parent EJB? No, therefore go to the next higher level in the hierarchy.
Is there a policy for the enterprise application that contains this URL pattern? Yes, use it. (If there were no such policy, the Security Service would have used the default root-level policy for EJBs.)
Figure 2-2 Hierarchy of Resources and Policies
Description of "Figure 2-2 Hierarchy of Resources and Policies"
You can see a visual representation of resource and policy hierarchies in the WebLogic Server Administration Console on the security realm's Roles and Policies: Policies page. For information about accessing this page, see Create policies for resource instances in the Oracle WebLogic Server Administration Console Online Help.
Designing Roles and Policies for WebLogic Resources: Main Steps
To secure WebLogic resources, define roles and policies to a list of resources in the domain. For this purpose, determine the kind of policies you want to create and analyze the user groups and roles associated with the group.
To design a set of roles and policies that can secure the resources in your domain:
List all of the resources that will be in your domain and determine which ones should be accessed only by specific users or groups.
To see a list of all the types of resources that could be in any given domain, see Resource Types You Can Secure with Policies.
For planning purposes, organize the resources into the following categories:
Server resources, administrative resources, and JMX resources. Server resources determine who can start and stop server instances. Administrative resources determine who can complete such tasks as unlocking users who have been locked out of their accounts, uploading files (used during deployment), and viewing the domain and server logs. JMX resources determine who can change the configuration of servers, clusters, machines, and other components that are defined in the domain's configuration document (config.xml).
For these tasks, WebLogic Server already provides a detailed, layered security scheme that grants different types of access to eight security roles (Admin, Deployer, Operator, Monitor, Anonymous, AppTester, CrossDomainConnector, AdminChannelUser). For most environments, this security scheme is adequate and only requires you to assign users to the eight default security roles appropriately (see step 3).
While it is possible to modify some parts of this layered security scheme, such modifications are usually not needed and require careful planning to maintain consistency between the different layers. See Administrative Resources, Server Resources, and JMX Resources.
Web application resources and EJB resources, which determine who can access the Web applications and EJBs that you deploy in your domain.
The Java EE platform already provides a standard model for securing Web applications and EJBs. In this standard model, developers define role mappings and policies in the Web application or EJB deployment descriptors.
You can use the standard model or you can use the WebLogic Server Administration Console to define polices and roles, which offers unified and dynamic security management. See Options for Securing Web Application and EJB Resources.
All other resources, which determine who can access the business logic and business content in the enterprise applications and other modules that you deploy or otherwise configure for the domain.
By default, these resources are not protected by policies; you must define policies to determine who can access them.
For each type of resource that you want to secure, determine if you need to create root-level policies, scoped policies, or a combination of both.
A root-level policy applies to all instances of a resource type. For example, if you define a root-level policy for the Web Services resource type, then the policy will apply to all Web Services in your domain.
A scoped policy applies to a specific resource instance and overrides a root-level policy.
See Security Policies.
Analyze your users and the resources that you want them to access. Organize users into security groups and roles as follows:
Add any user that you want to start and stop servers or to engage in other administrative tasks to one of the eight default global roles. The WebLogic Server security scheme allows only the eight global roles to perform many of these tasks.
For other users (that you do not want to access administrative or server resources but you do want to access other resources for which you have defined policies), create additional security groups and roles. Because role membership can be granted at run time, you can place users or groups in roles based on business rules or the context of the request.
You can create global roles, which can be used in any policy, or scoped roles, which can be used only in a policy for a specific resource instance.
Use the WebLogic Server Administration Console to create users, groups, roles, and policies:
To create the users and groups, see Manage users and groups in Oracle WebLogic Server Administration Console Online Help.
To create security roles, see Manage security roles in Oracle WebLogic Server Administration Console Online Help.
To create security policies, see Manage security policies in Oracle WebLogic Server Administration Console Online Help.
Best Practices: Conditionalize Policies or Conditionalize Roles
Because both roles and policies can evaluate a set of conditions at run time, you should consider which parts of your security data should be static and which should be dynamic. For example, you might want some policies to always allow one specific role to access a resource, and then you use conditions in the role's definition to move users in and out of the roles as needed. In other cases, you might want a static role definition and create a policy that allows access to different roles at different times of the day.
As a general guideline, if you base the authorization decision on the resource instead of the entities (roles) who can access the resource, you would add conditions to the security policy. If you base authorization on who can access the resource, then you would add conditions to the security role.
For an example of authorization based on who can access the resource, consider a manager who is going on vacation. You can temporarily place a user in a
Manager security role. Dynamically granting this security role means that you do not need to change or redeploy your application to allow for such a temporary arrangement. You simply specify the hours between which the temporary manager should have special privileges. Further, you do not need to remember to revoke these special privileges when the actual manager returns as you would if you temporarily added the user to a management group.
Best Practices: Configure Entitlements Caching When Using WebLogic Providers
The WebLogic Authorization provider, known as the
DefaultAuthorizer, and the WebLogic Role Mapping provider, referred to as the
DefaultRoleMapper, improve performance by caching the roles, predicates, and resource data that they look up. If you modify your realm to use these WebLogic providers, you can configure the maximum number of items that they store in the caches.
In WebLogic Server 18.104.22.168.0, the WebLogic Authorization provider (
DefaultAuthorizer) and the Role Mapping provider (
DefaultRoleMapper) are deprecated and will be removed in a future release.
By default, security realms in newly created domains include the XACML Authorization and Role Mapping providers. The XACML providers use their own cache, but this cache is not configurable. The WebLogic Authorization provider (
DefaultAuthorizer) and the Role Mapping provider (
DefaultRoleMapper) are the only WebLogic-provided security providers with configurable caches of entitlement data.
By default, the Weblogic Authorization and Role Mapping providers store the following number of items in each cache:
2000 items in the roles cache
This cache contains the name of each role that has been looked up and the policy that protects it.
200 items in the predicates cache
This cache contains each predicate that the WebLogic entitlements engine has looked up.
5000 items in the resources cache
This cache contains the name of each resource that has been looked up and the policy that protects it.
If a cache exceeds its maximum size, the WebLogic entitlements engine removes the least recently used (LRU) item from the cache.
If the applications on a WebLogic Server instance use more than 2000 roles or 5000 resources, consider increasing the cache sizes. (The WebLogic providers include less than 50 predicates, so there is no need to increase the size of this cache.)
To change the maximum number of items that a cache contains, pass one of the following system properties in the
java startup command for a WebLogic Server instance:
max-rolesis the maximum number of roles that you want to cache.
max-predicatesis the maximum number of predicates that you want to cache.
max_resource_countis the maximum number of resources that you want to cache.
By default, the WebLogic providers add items to the cache as they use them. With this configuration, the initial lookup of entitlement data takes longer than subsequent lookups. You can, however, decrease the amount of time needed for an initial lookup by configuring a WebLogic Server instance to load the caches during its startup cycle. To do so, pass the following system property to the server's
java startup command:
java -Dweblogic.entitlement.engine.cache.max_role_count=6001 -Dweblogic.entitlement.engine.cache.max_resource_count=3001 -Dweblogic.entitlement.engine.cache.preload=true weblogic.Server