9 Managing the RDBMS Security Store

This chapter describes the WebLogic Server option of using an external RDBMS as a datastore for the authorization, role mapping, credential mapping, and certificate registry providers. This datastore, called the RDBMS security store, is strongly recommended for using SAML 2.0 services in two or more WebLogic Server instances in that domain, such as in a cluster.

This datastore, called the RDBMS security store, is required by the SAML 2.0 security providers in production environments so that the data they manage can be synchronized across all the WebLogic Server instances that share that data. (Use LDAP as the security store with the SAML 2.0 security providers only in development environments.)

Note:

In order to use the RDBMS security store, the preferred approach is first to create a domain in which the external RDBMS server is configured. Prior to booting the domain, you create the tables in the datastore that are required by the RDBMS security store. The WebLogic Server installation directory contains a set of SQL scripts that create these tables for each supported database.

This chapter includes the following sections:

For the most up-to-date details about the specific database systems that are supported for use as the RDBMS security store for WebLogic Server, see the Oracle Fusion Middleware Supported System Configurations page on Oracle Technology Network.

Security Providers that Use the RDBMS Security Store

The following security providers use the RDBMS security store if that store is configured in a domain:

  • XACML Authorization provider

  • XACML Role Mapping provider

  • The following providers for SAML 1.1:

    • SAML Identity Assertion provider V2

    • SAML Credential Mapping provider V2

  • The following providers for SAML 2.0:

    • SAML 2.0 Identity Assertion provider

    • SAML 2.0 Credential Mapping provider

  • WebLogic Credential Mapping provider

  • PKI Credential Mapping provider

  • Certificate Registry

When the RDBMS security store is configured in a domain, an instance of any of the preceding security providers that has been created in the security realm automatically uses only the RDBMS security store as a datastore, and not the embedded LDAP server. WebLogic security providers configured in the domain that are not among those in the preceding list continue to use their respective default stores; for example, the Default Authentication provider continues to use the embedded LDAP server.

Oracle recommends that you configure the RDBMS security store at the time of domain creation. WebLogic Server includes the RDBMSSecurityStoreMBean, which is the interface for configuring the RDBMS security store via the WebLogic Scripting Tool (WLST). (The Configuration Wizard does not provide the ability to configure the RDBMS security store.)

Configuring the RDBMS Security Store

To create and configuring the RDBMS security store in a domain, complete the tasks described in the following sections:

Create a Domain with the RDBMS Security Store

To use the RDBMS security store in a domain, Oracle recommends that you configure the RDBMS security store at the time you create that domain. Modifying an existing domain in place to use the RDBMS security store is possible; however, it is not recommended because if the database connection is not configured correctly, the policies necessary for granting access to the domain could become unavailable, resulting in a domain that cannot be used.

You configure the RDBMS security store by using the WebLogic Scripting Tool (WLST) Offline. (The Configuration Wizard does not provide the ability to configure the RDBMS security store.) Operations for creating and configuring the RDBMS security store are available via the RDBMSSecurityStoreMBean. You also need to configure the connection properties for the database that serves as the RDBMS security store as explained in the following sections.

Specifying Database Connection Properties

When configuring the RDBMS security store, you need to specify or configure the following:

  • RDBMS type

    The following RDBMS systems are supported for containing the RDBMS security store:

    • Oracle 9i, 10g, and 11g

    • MS-SQL 2000 and 2005

    • DB2 9.2 and 9.5

  • JDBC driver and class name for connecting to the RDBMS

  • RDBMS name, host, port, and URL

  • Username and password of the domain user who can access the RDBMS system

    Caution:

    For clarity, the WLST examples provided in this section show passing username and password credentials of the RDBMS system user in clear text. However, you should avoid entering clear-text passwords in WLST commands in general, and you should especially avoid saving on disk WLST scripts that include clear-text passwords. In these instances you should use a mechanism for passing encrypted passwords instead.

  • Optionally, any properties that need to be passed to the RDBMS system

The parameters that you specify in the JDBC driver connection properties attribute must be a comma-separated list. The following examples show the use of WLST to configure the database connection properties for Oracle, MS-SQL, and DB2.

Oracle Example

Example 9-1 shows an example of configuring Oracle for the RDBMS security store.

Example 9-1 Configuring Oracle for the RDBMS Security Store

create('base_domain','SecurityConfiguration') 
cd('/SecurityConfiguration/base_domain') 
a=get('DefaultRealm') 
cd('Realm/myrealm') 
rdbms = create("myRDBMSSecurityStore", "RDBMSSecurityStore") 
rdbms.setUsername('ortiz') 
rdbms.setPassword('password') 
rdbms.setConnectionURL('jdbc:bea:oracle://avitek21:1521') 
rdbms.setDriverName('weblogic.jdbc.oracle.OracleDriver') 
rdbms.setConnectionProperties('user=ortiz,portNumber=1521,SID=pint101a,serverName=avitek21') 
MS-SQL Example

Example 9-2 shows an example of configuring MS-SQL for the RDBMS security store.

Example 9-2 Configuring MS-SQL for the RDBMS Security Store

create('base_domain','SecurityConfiguration') 
cd('/SecurityConfiguration/base_domain') 
a=get('DefaultRealm') 
cd('Realm/myrealm') 
rdbms = create("myRDBMSSecurityStore", "RDBMSSecurityStore") 
rdbms.setUsername('garnett') 
rdbms.setPassword('password') 
rdbms.setConnectionURL('jdbc:bea:sqlserver://avitek6:1433') 
rdbms.setDriverName('weblogic.jdbc.sqlserver.SQLServerDriver') 
rdbms.setConnectionProperties('user=garnett,portNumber=1433,databaseName=wls3,serverName=avitek6') 
DB2 Example

Example 9-3 shows an example of configuring DB2 for the RDBMS security store.

Note:

If you choose DB2, you have the option of selecting the WebLogic Type 4 JDBC driver for DB2 that is provided in WebLogic Server. However, if you use this JDBC driver, you must also specify the additional property BatchPerformanceWorkaround and set it to true. If you do not set the BatchPerformanceWorkaround to true in this configuration, WebLogic Server may fail to boot, generating a SecurityServiceException message.

Example 9-3 Configuring DB2 for the RDBMS Security Store

create('base_domain','SecurityConfiguration') 
cd('/SecurityConfiguration/base_domain') 
a=get('DefaultRealm') 
cd('Realm/myrealm') 
rdbms = create("myRDBMSSecurityStore", "RDBMSSecurityStore") 
rdbms.setUsername('brady') 
rdbms.setPassword('password') 
rdbms.setConnectionURL('jdbc:bea:db2://avitek3:50000') 
rdbms.setDriverName('weblogic.jdbc.db2.DB2Driver') 
rdbms.setConnectionProperties('user=brady,portNumber=50000,databaseName=wls,serverName=avitek3,batchPerformanceWorkaround=true') 

For more information about specifying connection properties for the WebLogic Type 4 JDBC driver for DB2, see "Using DataDirect Documentation" in Developing JDBC Applications for Oracle WebLogic Server.

For More Information About Default Connection Properties

Internally, the RDBMS security store uses Oracle Kodo to connect to and interoperate with the database using the WebLogic Type 4 JDBC driver for DB2. The attributes set on the RDBMSSecurityStoreMBean are converted into attributes set on the properties of Kodo's javax.sql.DataSource implementation.

For more information about these attributes, see the following topics:

  • For more information about the attributes you can set on the RDBMSSecurityStoreMBean, see "RDBMSSecurityStoreMBean" in the MBean Reference for Oracle WebLogic Server.

  • For information about the default database connection properties in the Kodo DataDource, see "Using the Kodo DataSource" in the JDBC chapter of the Kodo JPA/JDO Reference Guide.

Testing the Database Connection

When you configure the RDBMS security, Oracle strongly recommends testing the database connection to verify that the connection is set up properly. If there were a problem with the database connection, you might not be able subsequently to boot the domain if the security providers that control access to that domain are unable to obtain the necessary security policies.

Create RDBMS Tables in the Security Datastore

Prior to booting the domain, the database administrator needs to run the SQL script that creates the RDBMS tables in the datastore used by the RDBMS security store. A set of SQL scripts for creating these tables for, and also removing them from, each supported RDBMS system is available in the following WebLogic Server installation directory:

WL_HOME/server/lib 

When running the appropriate SQL script for the database serving as the RDBMS security store, be sure to specify the same connection properties, including the credentials of the user who has access, the database URL, etc., as specified for that RDBMS during domain creation.

Table 9-1 identifies the name of each of these SQL scripts.

Table 9-1 SQL Scripts for Creating and Removing RDBMS Datastore Tables

RDBMS Script for Creating Datastore Tables Script for Removing Datastore Tables

Oracle 9i, 10g, 11g

rdbms_security_store_oracle.sql

rdbms_security_store_oracle_remove.sql

MS-SQL 2000, 2005

rdbms_security_store_sqlserver.sql

rdbms_security_store_sqlserver_remove.sql

DB2 9.2, 9.5

rdbms_security_store_db2.sql

rdbms_security_store_db2_remove.sql

Derby

rdbms_security_store_derby.sql

rdbms_security_store_derby_remove.sql


Configure a JMS Topic for the RDBMS Security Store

If the RDBMS security store is configured in a domain that includes two or more WebLogic Server instances, or a cluster, Oracle strongly recommends that you also perform the following tasks:

  1. Enable JMS notifications for that domain.

  2. Configure a JMS topic that can be used by the RDBMS security store.

JMS notifications enable the security data that is contained in the RDBMS security store, and that is managed by security providers in the realm, to be synchronized among all server instances in the domain.

Caution:

If you do not configure a JMS topic that can be used by the RDBMS security store when configured in a multi-server or clustered domain, care should be taken when making security policy or security configuration updates. If no JMS topic is configured, it may be necessary to reboot the domain to ensure that all server instances function consistently with regards to those security updates.

You can enable JMS notifications by booting the domain in which the RDBMS security store has been configured, and configuring attributes on the RDBMSSecurityStoreMBean via either of the following mechanisms:

  • WebLogic Scripting Tool

  • The Security Realms > RealmName > RDBMS Security Store page in the Administration Console

The attributes of the RDBMSSecurityStoreMBean that must be set to enable JMS notifications are listed and described in Table 9-2.

Table 9-2 RDBMSSecurityStoreMBean Attributes for Configuring a JMS Topic

Attribute Name Description
JMSTopic

The JMS topic to which the Kodo remote commit provider should publish notifications and subscribe for notifications sent from other JVMs. The target JMS topic needs to be pre-deployed.

JMSTopicConnectionFactory

The JNDI name of a javax.jms.TopicConnectionFactory instance to use for finding JMS topics.

The topic "Connection Factory Configuration" in Administering JMS Resources for Oracle WebLogic Server describes the WebLogic JMS connection factory, weblogic.jms.ConnectionFactory, which is a javax.jms.TopicConnectionFactory instance. Refer to this topic for information about configuring a connection factory.

NotificationProperties

A comma-delimited list of key-value properties to pass to the JNDI InitialContext on construction, in the form of xxKey=xxValue, xxKey=xxValue. The following properties must be specified:

  • java.naming.provider.url — Property for specifying configuration information for the service provider to use. The value of the property should contain a URL string. For example:

    iiops://localhost:7002
    
  • java.naming.factory.initial — Property for specifying the initial context factory to use. The value of the property should be the fully-qualified class name of the factory class that will create an initial context. For example:

    weblogic.jndi.WLInitialContextFactory
    
JNDIUserName

The identity of any valid user in the security realm who has access to JNDI.

JNDIPassword

The password of the user specified in the JNDIUserName attribute.

JMSExceptionReconnectAttempts

The number of reconnect attempts to be made if the JMS system notifies Kodo of a serious connection error. The default is 0, which causes an error to be logged, but does not result in a reconnect attempt.


For more information, see the following topics:

Configuring JMS Connection Recovery in the Event of Failure

Normally, the WebLogic Security Service contained in each WebLogic Server instance in a multi-node domain connects at startup to the JMS server. If a security provider that uses the RDBMS security store makes a change to its security data, all WebLogic Server instances are notified via JMS, and the local caches used by the WebLogic Security Service in each server instance are synchronized to that change.

If the JMS connection fails in a WebLogic Server instance that has been successfully started, the WebLogic Security Service associated with that server instance starts the JMS connection recovery process. The recovery process sleeps one second between reconnect attempts. The recovery process is stopped if the JMS connection failure persists after the number of reconnect attempts with which the JMSExceptionReconnectAttempts property has been configured is reached. No further reconnect attempts are made: If a change is made to the security data in one WebLogic Server instance, the local caches managed by the WebLogic Security Service in other WebLogic Server instances are not synchronized to that change. However, if the JMS connection is successfully recovered by other means (such as a server reboot), those caches become synchronized.

If the JMS connection is not successfully started at the time a WebLogic Server instance is booted, a timer task that makes reconnect attempts is automatically started. The timer task is cancelled once the connection is successfully made. Two system properties may be configured for this timer task:

  • com.bea.common.security.jms.initialConnectionRecoverInterval

    Specifies the delay, in milliseconds, before the connection recovery task is executed. The default value is 1000, which causes the connection recovery process to be executed after a delay of one second.

  • com.bea.common.security.jms.initialConnectionRecoverAttempts

    Specifies the maximum number of reconnect attempts that can be made prior to cancelling the timer task. The default value is 3600, which causes the timer task to be cancelled once 3600 reconnect attempts have been made. No further reconnect attempts are made.

You can calculate the maximum connection polling duration by multiplying the values specified by each of the preceding system properties. For example, multiplying the default values of these two properties yields a maximum polling duration of one hour (1000 millisecond delay multiplied by 3600 reconnect attempts).

Upgrading a Domain to Use the RDBMS Security Store

To upgrade a domain to use the RDBMS security store, Oracle recommends creating a new domain in which the RDBMS security store is configured. After you create the new domain, you should export the security data from the security realm of the old domain, and import it into a security realm of the new domain. When you import security data into a security realm in a domain that uses the RDBMS security store, the data for the security providers that use the RDBMS security store is automatically loaded into that datastore. Data for security providers that do not use the RDBMS security store is automatically imported into the stores that those providers normally use by default.

It is possible to selectively migrate security providers individually from one security realm to another. However, when migrating security data to a domain that uses the RDBMS security store, Oracle recommends migrating the security realm's data in a single operation.

For information about migrating security realms, see the following topics: