Preconfigured sample files for Liberty

To minimize manual configuration, preconfigured sample files are available for you to use and customize when you are using WebSphere® Application Server Liberty as your application server.

The preconfigured sample files are provided in the <ODM_InstallDir>/shared/oidc directory.

The following table shows the sample files that you can customize:
Table 1. Preconfigured sample files
File name Description Related task

server.xml

The main configuration file for Liberty.

The sample server.xml file is partitioned by other XML files. That is, the following files are included in the sample server.xml file:
  • tls-datasource.xml
  • filters.xml
  • oidc-liberty.xml

Apart from these include statements, the other lines in server.xml that are required are:

  • In the <featureManager> element:
    <feature>openidConnectClient-1.0</feature>
  • In all three of the Decision Center <application> elements (decisioncenter.war, decisioncenter-api.war and decisionmodel.war), in order to find the OdmOidcProviders.json file in the directory ${server.config.dir}/resources/security:
    <classloader delegation="parentLast" commonLibraryRef="ExtensionsLib"/>

Configuring Relying Parties in the Liberty server

tls-datasource.xml

This file is included in the sample server.xml file:

<include location="tls-datasource.xml"/>

It does not only contain the security and data source configuration.

It also contains the lines below, which allow Decision Center to find the OdmOidcProviders.json file in the directory ${server.config.dir}/resources/security:

<library id="ExtensionsLib">
       <fileset dir="${shared.resource.dir}" includes="ExtensionsLib.jar" />
       <folder dir="${server.config.dir}/resources/security" />
   </library> 

Configuring Relying Parties in the Liberty server

filters.xml

The filter configuration file. This file is already included in the sample server.xml file:

<!-- Includes the filters to partition Operational Decision Manager into "browsing" and "API" -->
<include location="filters.xml"/>

Configuring Relying Parties in the Liberty server

oidc-liberty.xml

oidc-ums.xml

oidc-ibmid.xml

The OpenID Connect client configuration file.

The oidc-liberty.xml file is already included in the sample server.xml file:
<!-- Includes the OIDC client configuration -->
<include location="oidc-liberty.xml"/>
You must change it if you choose another oidc-<name>.xml file, because you can include only one of the files in the server.xml file.

Configuring Relying Parties in the Liberty server

jvm.options

This sample file contains all JVM options.

Passing parameters and registering the truststore

Passing parameters to the Decision Center Business console

OdmOidcProviders.json

The JSON description file to define OpenID Connect Providers for Decision Center. This file should be located in the <server>/resources/security directory for Liberty.

Defining OpenID Connect Providers for Decision Center

OdmOidcProvidersRD.json

The JSON description file to define OpenID Connect Providers for Rule Designer. This file should be located in the Eclipse root directory. You can also specify a different location using the property -Dcom.ibm.rules.authentication.oidcconfig in eclipse.ini.

Defining OpenID Connect Providers for Rule Designer

eclipse.ini

The eclipse.ini file for Rule Designer.

Passing parameters to Rule Designer

mykeystore.jks

mytruststore.jks

In Decision Center, you must move the .jks files to the resources/security directory for Liberty.

In Rule Designer, only the file mytruststore.jks is needed, and it should be located in the Eclipse root directory. You can also specify a different location using the property -Djavax.net.ssl.trustStore in eclipse.ini.

For the .jks, the password is password2Change. You must change this password.

You must fill these files with the actual certificates for your system.

  • mykeystore.jks must contain keys only.
  • mytruststore.jks must contain only public certificates only.
 
Note: If you choose to use any one of the preconfigured sample files to minimize manual configuration, you must check the content of the file and customize the configuration to suit your system. Values suffixed with 2Change in the sample files must be changed, and any value that does not match in your environment must be updated.