8 Configuring Oracle Information Rights Management

This chapter explains how to configure an Oracle Information Rights Management (Oracle IRM) application in an Oracle WebLogic Server domain, in these topics:

Performing Postinstallation Configuration
Accessing the Oracle IRM Management Console
Configuring the Identity Store

8.1 Performing Postinstallation Configuration

Before logging in to the Oracle IRM Management Console or using Oracle IRM Desktop, you need to complete the Oracle IRM configuration, as these topics describe:

Setting the Server URL Configuration Parameter for Oracle IRM
Configuring a Key Store for Oracle IRM

Note:

In a production environment, Oracle Enterprise Content Management Suite (Oracle ECM) applications need to use an external Lightweight Directory Application Protocol (LDAP) authentication provider rather than the Oracle WebLogic Server embedded LDAP server, which is part of the default configuration. If you want to reassociate the identity store for Oracle IRM with an external LDAP authentication provider, it is easier to do this before you complete the configuration of the Oracle IRM Managed Server. For more information, see Section 4.9, "Reassociating the Identity Store with an External LDAP Authentication Provider."

8.1.1 Setting the Server URL Configuration Parameter for Oracle IRM

You can set the Server URL configuration parameter to an Oracle IRM Managed Server on the General Settings page for Oracle IRM in Oracle Enterprise Manager Fusion Middleware Control.

Caution:

The Server URL value is embedded into every sealed document, and Oracle IRM Desktop uses this value to identify and connect to an Oracle IRM server to retrieve licenses. This setting must not be changed after any documents have been sealed using this server, or no one will be able to access the documents.

For a simple installation where the Managed Server is directly accessible to Oracle IRM Desktop, this value will be the URL of the Managed Server. For example:

https://managedServerHost:managedServerPort/irm_desktop

To set the Server URL configuration parameter:

Start Fusion Middleware Control at the following web site:
```
http://adminServerHost:adminServerPort/em
```
For adminServerHost, specify the name of the computer that hosts the Administration Server for your domain. For adminServerPort, specify the listen port number for the Administration Server. The default number is 7001. For example:
```
http://myHost:7001/em
```
To log in, supply the user name and password that were specified on the Configure Administrator User Name and Password screen in the configuration wizard.
From the farm navigation tree in Application Server Control, expand Content Management and Information Rights Management, and then click irm.
From the IRM menu, select Administration and then General Settings.

Fusion Middleware Control displays the General Settings page.
In the Server URL field, enter the URL to access the Oracle IRM Managed Server.

For a simple installation where the Managed Server is directly accessible to Oracle IRM Desktop, this value will be the URL of the Managed Server; for example:
```
https://managedServerHost:managedServerPort/irm_desktop
```
The managedServerHost value is the name of the host where the Managed Server is running, such as myhost.example.com. The default SSL port for Oracle IRM (managedServerPort value) is 16101.

On the General Settings page, you can also specify other settings for Oracle IRM.
Click Apply.

8.1.2 Configuring a Key Store for Oracle IRM

The Oracle IRM Java EE application uses a cryptographic key to wrap (encrypt) and unwrap (decrypt) Oracle IRM sealed content keys stored in the database. This wrapping key, oracle.irm.wrap, must be generated and stored in a key store before contexts can be created.

Access to the key store requires a password, and access to the wrapping key requires an additional password. Both passwords are stored in the credential store.

To configure a key store for Oracle IRM, you need to do the tasks described in these topics:

Choosing a Cryptographic Algorithm, Key Size, and Key Store
Creating a Key Store
Setting the Key Store Location
Adding Key Store Passwords to the Credential Store
Configuring the Policy and Credential Store

8.1.2.1 Choosing a Cryptographic Algorithm, Key Size, and Key Store

Due to algorithm restrictions with certain Java Cryptographic Extension (JCE) security providers, a number of different cryptographic algorithms and types of key stores are supported. You should choose the most appropriate cryptographic algorithm, key size, and key store for the target platform. For most platforms, the Advanced Encryption Standard (AES) key wrapping algorithm should be used. Other platforms require an RSA key wrapping algorithm.

8.1.2.1.1 AES Algorithm

With the AES algorithm, the size of the wrapping key can either 256 bits or 128 bits. To seal content using the AES 256 cryptographic schema, you should use a 256 bit wrapping key. To seal content using the AES 128 cryptographic schema, you can use a 128 bit or 256 bit wrapping key. The AES key wrap algorithm is typically faster than the RSA key wrap algorithm.

Note:

Before you can use AES with a 256-bit key size, the Java Cryptography Extension (JCE) Unlimited Strength Jurisdiction Policy Files need to be installed in the JRE directory of Oracle WebLogic Server. For more information about downloading the policy files, see the Java SE Downloads page on the Oracle Sun Technology Network at

http://java.sun.com/javase/downloads/index.jsp

8.1.2.1.2 RSA Algorithm

For installing Oracle IRM on an AIX platform, the only supported key wrapping algorithm with the IBMJCE security provider is RSA. With RSA you should use a 2048 bit key.

8.1.2.2 Creating a Key Store

The keytool command will generate a key store, which requires a password to open. Inside the key store, a key, oracle.irm.wrap, will be stored, and access to this key requires an additional password.

To create a key store for Oracle IRM:

Run the WLSEnv script to set the environment:
- UNIX operating system
```
cd MW_HOME/wlserver_10.3/server/bin
./setWLSEnv.sh
```
  For the Java and Oracle WebLogic Server tools to work, you should have the weblogic.jar file in the MW_HOME/wlserver_10.3/server/lib directory.
- Windows operating system
```
MW_HOME\wlserver_10.3\server\bin\setWLSEnv.cmd
```
  For the Java and Oracle WebLogic Server tools to work, you should have the weblogic.jar file in the MW_HOME\wlserver_10.3\server\lib directory.
Setting the environment correctly results in keytool being in the user's PATH environment variable. This setting specifies the directory path to use for the keytool command in the rest of this procedure.
Run the keytool utility to generate an Oracle IRM key store.
- For AES, enter the following keytool command, on a single command line (the key size can be either 128 or 256):
```
keytool
   -genseckey -storetype JCEKS -alias oracle.irm.wrap 
      -keyalg AES -keysize 128 -keystore irm.jceks
```
  When prompted by keytool, choose appropriate passwords for the key store and the generated key.
- For RSA, enter the following keytool command, on a single command line:
```
keytool -genkeypair -alias oracle.irm.wrap 
      -keyalg RSA -keysize 2048 -keystore irm.jks
```
  When prompted by keytool for the certificate details, use the suggested default value, unknown. When prompted for passwords for the key store and the generated key, choose appropriate values.

Copy the irm.jceks or irm.jks file to the domain's fmwconfig directory:

UNIX operating system

MW_HOME/user_projects/domains/domain_name/config/fmwconfig/

Windows operating system

MW_HOME\user_projects\domains\domain_name\config\fmwconfig\

8.1.2.3 Setting the Key Store Location

The Oracle IRM server configuration needs to be updated so that it can locate the key store file. You can set the key store location in the server configuration with either Fusion Middleware Control, on the Oracle IRM General Settings page, or with the WebLogic Scripting Tool (WLST) connect and setIRMKeyStore commands.

The suggested location for the key store is in a directory under the domain home:

UNIX operating system

MW_HOME/user_projects/domains/domain_name/config/fmwconfig

Windows operating system

MW_HOME\user_projects\domains\domain_name\config\fmwconfig

Placing the key store in this location ensures that the key store file is backed up when the domain and corresponding credential store files are backed up.

To set the key store location with Fusion Middleware Control:

Start Fusion Middleware Control at the following URL:
```
http://adminServerHost:adminServerPort/em
```
For adminServerHost, specify the name of the computer that hosts the Administration Server for your domain. For adminServerPort, specify the listen port number for the Administration Server. The default number is 7001. For example:
```
http://myHost:7001/em
```
To log in, supply the user name and password that were specified on the Configure Administrator User Name and Password screen in the configuration wizard.
From the farm navigation tree in Fusion Middleware Control, expand Content Management and Information Rights Management, and then click irm.
From the IRM menu, select Administration and then General Settings.
For the key store type, enter one of the following values:
- JCEKS if you are using an AES key
- JKS if you are using an RSA key-pair

In the Keystore field on the General Settings page, enter one of the following key store paths.

Key store path for a JCEKS key store:

UNIX operating system

MW_HOME/user_projects/domains/domain_name/config/fmwconfig/irm.jceks

Windows operating system

MW_HOME\user_projects\domains\domain_name\config\fmwconfig\irm.jceks

Key store path for a JKS key store:

UNIX operating system

MW_HOME/user_projects/domains/domain_name/config/fmwconfig/irm.jks

Windows operating system

MW_HOME\user_projects\domains\domain_name\config\fmwconfig\irm.jks

On the General Settings page, you can also specify other settings for Oracle IRM.
Click Apply.

To set the key store location with WLST commands:

Enter the following commands:
- UNIX operating system
```
ECM_ORACLE_HOME/common/bin/wlst.sh
connect('username','password','t3://adminServerHost:adminServerPort')
setIRMKeyStore()
```
- Windows operating system
```
ECM_ORACLE_HOME\common\bin\wlst.cmd
connect('username','password','t3://adminServerHost:adminServerPort')
setIRMKeyStore()
```
For adminServerHost, specify the name of the computer that hosts the Administration Server for your domain. For adminServerPort, specify the listen port number for the Administration Server. The default number is 7001. For example:
```
http://myHost:7001/em
```
You will be prompted for the key store type and key store path.
- For the key store type, enter one of the following values:
  - JCEKS if you are using an AES key
  - JKS if you are using an RSA key-pair
- For the key store path, enter one of the following values.
  - Key store path for an AES key store:
    
    UNIX operating system
```
MW_HOME/user_projects/domains/domain_name/config/fmwconfig/irm.jceks
```
    Windows operating system
```
MW_HOME\user_projects\domains\domain_name\config\fmwconfig\irm.jceks
```
  - Key store path for an RSA key store:
    
    UNIX operating system
```
MW_HOME/user_projects/domains/domain_name/config/fmwconfig/irm.jks
```
    Windows operating system
```
MW_HOME\user_projects\domains\domain_name\config\fmwconfig\irm.jks
```

8.1.2.4 Adding Key Store Passwords to the Credential Store

You must add passwords for the Oracle IRM key store to the credential store with WLST commands. A key store password and a password for the generated key were set when the key store was created. These passwords are required by the Oracle IRM server.

To add key store passwords to the credential store:

For an AES key store, enter the following WLST commands:

UNIX operating system

ECM_ORACLE_HOME/common/bin/wlst.sh
connect('username','password','t3://adminServerHost:adminServerPort')
createCred("IRM","keystore:irm.jceks","dummy","password")
createCred("IRM","key:irm.jceks:oracle.irm.wrap","dummy","password")

Windows operating system

ECM_ORACLE_HOME/common/bin/wlst.cmd
connect('username','password','t3://adminServerHost:adminServerPort')
createCred("IRM","keystore:irm.jceks","dummy","password")
createCred("IRM","key:irm.jceks:oracle.irm.wrap","dummy","password")

Notes:

In the connect command, substitute the correct values for username and password.
In the createCred command, substitute for password the password that was used for creating the key and key store.
The "dummy" parameter passed to the createCred command is the user name parameter. The key store does not use a user name, so this value is ignored. This is why the value is set as dummy.
It is normal for the creatCred command to return the text "Already in Domain Runtime Tree". This text does not signify an error.

For an RSA key store, enter the following WLST commands:

UNIX operating system

ECM_ORACLE_HOME/common/bin/wlst.sh
connect('username','password','t3://adminServerHost:adminServerPort')
createCred("IRM","keystore:irm.jks","dummy","password")
createCred("IRM","key:irm.jks:oracle.irm.wrap","dummy","password")

Windows operating system

ECM_ORACLE_HOME/common/bin/wlst.cmd
connect('username','password','t3://adminServerHost:adminServerPort')
createCred("IRM","keystore:irm.jks","dummy","password")
createCred("IRM","key:irm.jks:oracle.irm.wrap","dummy","password")

Notes:

In the connect command, substitute the correct values for username and password.
In the createCred command, substitute for password the password that was used for creating the key and key store.
The "dummy" parameter passed to the createCred command is the user name parameter. The key store does not use a user name, so this value is ignored. This is why the value is set as dummy.
It is normal for the creatCred command to return the text "Already in Domain Runtime Tree". This text does not signify an error.

8.1.2.5 Configuring the Policy and Credential Store

Oracle IRM uses the Credential Store Framework of Oracle Platform Security Services (OPSS) to retrieve passwords for the Oracle IRM key store. There are no specific configuration steps for Oracle IRM if the credential and policy stores are reassociated with an external LDAP authentication provider, as described in Section 4.9, "Reassociating the Identity Store with an External LDAP Authentication Provider."

8.2 Accessing the Oracle IRM Management Console

When the Oracle IRM Managed Server is running, the Oracle IRM application is deployed and ready to be accessed through the Oracle IRM Management Console:

https://managedServerHost:managedServerPort/irm_rights

8.3 Configuring the Identity Store

Oracle IRM uses OPSS to obtain user and group details from the external LDAP authentication provider. For information about configuring the identity store, see Section 4.9, "Reassociating the Identity Store with an External LDAP Authentication Provider."