19 Configuring Single Sign-On for an Enterprise Deployment
You need to configure the Oracle HTTP Server WebGate in order to enable single sign-on with Oracle Access Manager.
- About Oracle Webgate
Oracle WebGate is a web server plug-in that intercepts HTTP requests and forwards them to an existing Oracle Access Manager instance for authentication and authorization. - General Prerequisites for Configuring Oracle HTTP Server WebGate
Before you can configure Oracle HTTP Server WebGate, you must have installed and configured a certified version of Oracle Access Manager. - Configuring Oracle HTTP Server WebGate for an Enterprise Deployment
You need to configure Oracle HTTP Server WebGate for Oracle Access Manager on both WEBHOST1 and WEBHOST2. - Adding a Load Balancer Certificate to WebGate
Oracle WebGate 14c uses REST calls to interact with Oracle Access Manager 14c. To ensure that the communication works properly, you have to copy the load balancer certificates to WebGate Config and ensure that the REST endpoints are set correctly. - Copying WebGates Artifacts to Web Tier
When you created your Oracle Access Management installation, a WebGate calledWebgate_IDM
was created. In order for WebGate to communicate with the Access servers, you must copy the artifacts associated with this WebGate to the web tier. - Restarting the Oracle HTTP Server Instance
Restart the Oracle HTTP Server so the configuration changes take effect. - Setting Up the WebLogic Server Authentication Providers
To set up the WebLogic Server authentication providers, back up the configuration files, set up the Oracle Access Manager Identity Assertion Provider and set the order of providers. - Adding the Administration Role to the New Administration Group
The adding of administration role to a new administration group enables all users that belong to the group to be administrators for the domain. - Configuring Oracle ADF and OPSS Security with Oracle Access Manager
Some Oracle Fusion Middleware management consoles use Oracle Application Development Framework (Oracle ADF) security, which can integrate with Oracle Access Manager Single Sign-on (SSO). These applications can take advantage of Oracle Platform Security Services (OPSS) SSO for user authentication, but you must first configure the domain-leveljps-config.xml
file to enable these capabilities.
About Oracle Webgate
Oracle WebGate is a web server plug-in that intercepts HTTP requests and forwards them to an existing Oracle Access Manager instance for authentication and authorization.
Oracle WebGate software is installed as part of the Oracle HTTP Server software installation. See Registering and Managing OAM Agents in Adminstrator’s Guide for Oracle Access Management. Oracle WebGate is available for Oracle HTTP Server.
Parent topic: Configuring Single Sign-On for an Enterprise Deployment
General Prerequisites for Configuring Oracle HTTP Server WebGate
Before you can configure Oracle HTTP Server WebGate, you must have installed and configured a certified version of Oracle Access Manager.
For the most up-to-date information, see the certification document for your release on the Oracle Fusion Middleware Supported System Configurations page.
For WebGate certification matrix, click and open Certification Matrix for 14c Access Management WebGates.
Note:
It is required that you use the WebGate version that is certified with your Oracle Access Manager deployment.For more information about Oracle Access Manager, see the latest Oracle Identity and Access Management documentation, which you can find in the Middleware documentation on the Oracle Help Center.
Parent topic: Configuring Single Sign-On for an Enterprise Deployment
Configuring Oracle HTTP Server WebGate for an Enterprise Deployment
You need to configure Oracle HTTP Server WebGate for Oracle Access Manager on both WEBHOST1 and WEBHOST2.
In the following procedure, replace the directory variables, such as WEB_ORACLE_HOME and WEB_CONFIG_DIR, with the values, as defined in File System and Directory Variables Used in This Guide.
-
Perform a complete backup of the web tier domain.
-
Change directory to the following location in the Oracle HTTP Server Oracle home:
cd
WEB_ORACLE_HOME
/webgate/ohs/tools/deployWebGate/
For Example:
cd /u02/oracle/products/ohs/webgate/ohs/tools/deployWebGate
-
Run the following command to create the WebGate Instance directory and enable WebGate logging on OHS Instance:
./deployWebGateInstance.sh -w WEB_CONFIG_DIR -oh WEB_ORACLE_HOME
For example:./deployWebGateInstance.sh -w /u02/oracle/config/domains/ohsDomain/config/fmwconfig/components/OHS/ohs1 -oh /u02/oracle/products/ohs
-
Verify that a
webgate
directory and subdirectories was created by thedeployWebGateInstance
command:ls -lat WEB_ORACLE_HOME/ohs
For Example:
ls -lat /u02/oracle/products/ohs/webgate/ohs
Output
total 4 drwxr-x---. 2 oracle oinstall 47 Dec 5 16:29 lib drwxr-x---. 2 oracle oinstall 103 Dec 5 16:29 config drwxr-x---. 8 oracle oinstall 88 Dec 5 16:29 . drwxr-x---. 4 oracle oinstall 40 Dec 5 16:29 tools drwxr-x---. 3 oracle oinstall 146 Dec 5 16:29 oamsso-bin drwxr-x---. 3 oracle oinstall 39 Dec 5 16:29 oamsso drwxr-x---. 29 oracle oinstall 4096 Dec 5 16:29 lang drwxr-x---. 3 oracle oinstall 17 Dec 5 16:29 ..
-
Run the following command to ensure that the
LD_LIBRARY_PATH
environment variable containsWEB_ORACLE_HOME/lib
directory path:export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:WEB_ORACLE_HOME/lib
For Example:
export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/u02/oracle/products/ohs/lib
-
Change directory to the following directory
WEB_ORACLE_HOME/webgate/ohs/tools/setup/InstallTools
For Example:
cd /u02/oracle/products/ohs/webgate/ohs/tools/setup/InstallTools
-
Run the following command from the
InstallTools
directory../EditHttpConf -w $WEB_CONFIG_DIR -oh $WEB_ORACLE_HOME -o output_file_name
For example:./EditHttpConf -w /u02/oracle/config/domains/ohsDomain/config/fmwconfig/components/OHS/ohs1 -oh /u02/oracle/products/ohs
Note:
The
-oh WEB_ORACLE_HOME
and-o output_file_name
parameters are optional.This command:
-
Copies the
apache_webgate.template
file from the Oracle HTTP Server Oracle home to a newwebgate.conf
file in the Oracle HTTP Server configuration directory. -
Updates the
httpd.conf
file to add one line, so it includes thewebgate.conf
. -
Generates a WebGate configuration file. The default name of the file is
webgate.conf
, but you can use a custom name by using the-o output_file_name
argument to the command.
-
Parent topic: Configuring Single Sign-On for an Enterprise Deployment
Adding a Load Balancer Certificate to WebGate
Oracle WebGate 14c uses REST calls to interact with Oracle Access Manager 14c. To ensure that the communication works properly, you have to copy the load balancer certificates to WebGate Config and ensure that the REST endpoints are set correctly.
- Copying the LoadBalancer Certificates to WebGate Config
- Ensuring that the REST Endpoints are Set Correctly
Parent topic: Configuring Single Sign-On for an Enterprise Deployment
Copying the LoadBalancer Certificates to WebGate Config
WebGate needs to trust your load balancer certificate. To ensure this trust, you
should add the load balancer's certificate to the cacert.pem
file,
which is located in WEB_CONFIG_DIR/webgate/config
.
openssl
command. The syntax of the command is as
follows:openssl s_client -connect LOADBALANCER:PORT -showcerts </dev/null 2>/dev/null|openssl x509 -outform PEM > LOADBALANCER.pem
openssl s_client -connect login.example.com:443 -showcerts </dev/null 2>/dev/null|openssl x509 -outform PEM > login.example.com.pem
This command saves the certificate to a file named
login.example.com.pem
.
If you do not have load balancer certificates in your WebGate truststore, copy the
login.example.com.pem
file to
WEB_CONFIG_DIR/webgate/config renaming it to
cacert.pem
.
cp login.example.com.pem WEB_CONFIG_DIR/webgate/config/cacert.pem
If you already have trusted certificates in WebGate, append the certificate
to the cacert.pem
file.
cp login.example.com.pem >> WEB_CONFIG_DIR/webgate/config/cacert.pem
Parent topic: Adding a Load Balancer Certificate to WebGate
Ensuring that the REST Endpoints are Set Correctly
To ensure that the REST endpoints are set correctly:
Parent topic: Adding a Load Balancer Certificate to WebGate
Copying WebGates Artifacts to Web Tier
When you created your Oracle Access Management installation, a WebGate called Webgate_IDM
was created. In order for WebGate to communicate with the Access servers, you must copy the artifacts associated with this WebGate to the web tier.
Parent topic: Configuring Single Sign-On for an Enterprise Deployment
Copying Generated Artifacts to the Oracle HTTP Server WebGate Instance Location
After you run the idmTool configOAM, it creates a
WebGate agent called Webgate_IDM. The process creates a number of artifacts relating
to that agent in
IAD_ASERVER_HOME/output/Webgate_IDM
.
These artifacts have to be copied to the Oracle HTTP Server configuration directory
on the Web Tier hosts.
The location of the files in the Oracle HTTP Server configuration directory depends on the Oracle Access Manager security mode setting (OPEN or CERT).
The following table lists the required location of each generated artifact in the Oracle HTTP Server configuration directory.
Table 19-1 Web Tier Host Location to Copy the Generated Artifacts
File | Location in WEB_CONFIG_DIR |
---|---|
wallet/cwallet.sso Foot 1 |
WEB_CONFIG_DIR/webgate/config/wallet/ |
ObAccessClient.xml |
WEB_CONFIG_DIR/webgate/config/ |
password.xml |
WEB_CONFIG_DIR/webgate/config/ |
aaa_key.pem |
WEB_CONFIG_DIR/webgate/config/ |
aaa_cert.pem |
WEB_CONFIG_DIR/webgate/config/ |
Footnote 1 Copy cwallet.sso
from the wallet folder and
not from the output folder. Even though there are 2 files with
the same name they are different. The one in the wallet sub
directory is the correct one.
Note:
ObAccessClient.xml
to
WEBHOST1
and WEBHOST2
, delete the cached
copy of ObAccessClient.xml
and its lock file,
ObAccessClient.xml.lck
from the servers. The cache location
on WEBHOST1
is:WEB_DOMAIN_HOME/servers/ohs1/cache/
WEBHOST2
:WEB_DOMAIN_HOME/servers/ohs2/cache/
Obtaining WebGate Artifacts
The easiest way to obtain the WebGate artifacts is to download them from the OAM console. To download, complete the following steps:
- Log in to the OAM console using the URL in URLs Used in This Chapter. Login using the OAM Administration user
(
oamadmin
). - Click Agents.
- On the Search screen, click Search.
- From the list of agents, select Webgate_IDM by clicking on its name.
- Download the artifacts using the download button. A zip file gets downloaded on the host machine you are using.
Copy the downloaded zip file to the Oracle HTTP Server machine and unzip it to the
WEB_CONFIG_DIR/webgate/config
location. The files get extracted to the correct locations.
Parent topic: Copying WebGates Artifacts to Web Tier
Restarting the Oracle HTTP Server Instance
Restart the Oracle HTTP Server so the configuration changes take effect.
For information about restarting the Oracle HTTP Server instance, see Restarting Oracle HTTP Server Instances by Using WLST in Administering Oracle HTTP Server.
If you have configured Oracle HTTP Server in a WebLogic Server domain, you can also use Oracle Fusion Middleware Control to restart the Oracle HTTP Server instances. See Restarting Oracle HTTP Server Instances by Using Fusion Middleware Control in Administering Oracle HTTP Server.
Parent topic: Configuring Single Sign-On for an Enterprise Deployment
Setting Up the WebLogic Server Authentication Providers
To set up the WebLogic Server authentication providers, back up the configuration files, set up the Oracle Access Manager Identity Assertion Provider and set the order of providers.
The following topics assumes that you have already configured the LDAP authenticator by following the steps in Creating a New LDAP Authenticator and Provisioning Enterprise Deployment Users and Group. If you have not already created the LDAP authenticator, then do so before you continue with this section.
Note:
You only need to perform these steps in the IAMGovernanceDomain, they will already have been performed in the IAMAccessDomain as part of running configOAM.- Backing Up the Configuration Files
You should first back up the relevant configuration files to ensure their safety. - Configuring a New Authenticator for Oracle WebLogic Server
- Setting Up the Oracle Access Manager Identity Assertion Provider
- Updating the Default Authenticator and Setting the Order of Providers
Parent topic: Configuring Single Sign-On for an Enterprise Deployment
Backing Up the Configuration Files
You should first back up the relevant configuration files to ensure their safety.
Back up the following configuration files:
IAD_ASERVER_HOME/config/config.xml IAD_ASERVER_HOME/config/fmwconfig/jps-config.xml IAD_ASERVER_HOME/config/fmwconfig/system-jazn-data.xml
Also back up the boot.properties
file for the Administration Server:
IAD_ASERVER_HOME/servers/AdminServer/security/boot.properties
Parent topic: Setting Up the WebLogic Server Authentication Providers
Configuring a New Authenticator for Oracle WebLogic Server
After installing Oracle Identity Management, the Oracle WebLogic Server embedded LDAP server is the default authentication source (identity store). To use a new identity store (for example, OID or OUD), as the main authentication source, you must configure the Oracle WebLogic Server domain to use a new authentication provider to use the new store. For more information, see Security Providers in Oracle WebLogic Remote Console Online Help.
- Use WebLogic Remote Console to connect to and manage the WebLogic Server domain through its Administration Server. See Connect to an Administration Server.
- In the Edit Tree, go to Security, then Realms, then myrealm, then Authentication Providers.
- Click New.
- In the Name field, enter
OID Provider
, or a name of your choosing. - Depending on your back-end LDAP directory, from the
Type drop-down list, select
OracleInternetDirectoryAuthenticator
orOracleUnifiedDirectoryAuthenticator
. - From the Control Flag drop-down list, select
SUFFICIENT
. - Click Create.
- On the Configuration page for the new
authentication provider, set the values on the Provider-Specific Parameters tab.
Specify the settings from the tables below using appropriate values for the identity
store you will be using in your environment.
Table 19-2 OID Authentication Provider Specific Values
Section Name Field Name Description Connection Host
The LDAP host name. For example,
idstore.example.com
.Connection Port
The LDAP host listening port number. For example,
1389
or1636
.Connection SSL Enabled Set to true if you are communicating with your directory over SSL
Connection Principal
The LDAP user DN used to connect to the LDAP server.
For example:
cn=
oimLDAP
,cn=systemids,dc=example,dc=comConnection Credential
The password for the LDAP administrative user entered as the Principal.
Users User Base DN
Specifies the DN under which your users start.
For example:
cn
=users,dc=example,dc=com
Users All Users Filter
The LDAP search filter. For example,
(&(uid=*) (objectclass=person))
. The asterix (*) filters for all users. Click More Info... for details.Users User From Name Filter
The LDAP search filter. Click More Info... for details.
Users User Name Attribute
The attribute that you want to use to authenticate (for example,
cn
,uid
, ormail
). Set as the default attribute for user name in the directory server. For example,uid
.Groups Group Base DN
Specifies the DN that points to your Groups node.
For example:
cn
=groups,dc=example,dc=com
General GUID attribute
The attribute used to define object GUIDs in LDAP.
orclguid
Note:
You should not change this default value; in most cases the default value here is sufficient.Table 19-3 OUD Authentication Provider Specific Values
Parameter Sample Value Value Description Host
For example:
idstore.example.com
The LDAP server's server ID.
Port
For example:
1389
or1636
The LDAP server's port number.
Principal
For example:
cn=
oimLDAP
,cn=systemids,dc=example,dc=comAny LDAP user that has ReadOnly access to the users and groups stored in LDAP.
Credential
Enter LDAP password.
The password used to connect to the LDAP server.
SSL Enabled
Unchecked (clear)
Specifies whether SSL protocol is used when connecting to the LDAP server.
If you select SSL, then you need to ensure that the certificate authority (CA) that issued the certificates for OUD are included in the WebLogic trust store.
User Base DN
For example:
cn
=users,dc=example,dc=com
Specifies the DN under which your users start.
All Users Filter
(&(uid=*)(objectclass=person))
Instead of a default search criteria for All Users Filter, search all users based on the
uid
value.If the User Name Attribute for the user object class in the LDAP directory structure is a type other than
uid
, then change that type in the User From Name Filter field.For example, if the User Name Attribute type is
cn
, then this field should be set to:(&(cn=*)(objectclass=person)))
User From Name Filter
For example:
(&(uid=%u)(objectclass=person))
If the User Name Attribute for the user object class in the LDAP directory structure is a type other than
uid
, then change that type in the settings for the User From Name Filter.For example, if the User Name Attribute type is
cn
, then this field should be set to:(&(cn=%u)(objectclass=person)))
.User Name Attribute
For example:
uid
The attribute of an LDAP user object that specifies the name of the user.
Use Retrieved User Name as Principal
Checked
Must be turned on.
Group Base DN
For example:
cn
=groups,dc=example,dc=com
Specify the DN that points to your Groups node.
All Groups Filter
(&(cn=*)(objectclass=groupOfUniqueNames))
Specify the group filter.
GUID Attribute
entryuuid
This value is prepopulated with
entryuuid
whenOracleUnifiedDirectoryAuthenticator
is used for OUD. Check this value if you are using Oracle Unified Directory as your authentication provider.Static Member DN Attribute
uniquemember
Static Group Name Attribute
cn
Static Group Object Class
groupofuniquenames
Static Group DNs from Member DN Filter
(&(uniquemember=%M)(objectclass=groupofuniquenames))
Dynamic Group Name Attribute
cn
Dynamic Group Object Class
groupofURLs
Dynamic Member URL Attribute
memberURL
- Click Save.
For more information about configuring authentication providers in Oracle WebLogic Server, see Configuring Authentication Providers in Administering Security for Oracle WebLogic Server.
- In the Edit Tree, go to Security, then Realms, then myrealm, then Authentication Providers.
- Select the default authentication provider (DefaultAuthenticator) to display its configuration page.
- On the Common tab, from the Control
Flag drop-down list, select
SUFFICIENT
. - Click Save.
- In the Edit Tree, go to Security, then Realms, then myrealm, then Authentication Providers.
- Select a provider name and use the arrow buttons to
order the list of providers as follows:
OID Authenticator (SUFFICIENT)
Default Authenticator (SUFFICIENT)
- Restart Oracle WebLogic Server.
Parent topic: Setting Up the WebLogic Server Authentication Providers
Setting Up the Oracle Access Manager Identity Assertion Provider
Set up an Oracle Access Manager identity assertion provider in the Oracle WebLogic Server Remote Console.
- Log in to the WebLogic Remote Console, if not already logged in.
- In the Edit Tree, navigate to Security > Realms > myrealm > Authentication Providers.
- Click New.
- In the Name field, enter OAM Provider or a name of your choice.
- From the Type drop-down list, select OAMIdentityAsserter.
- Set the control flag to REQUIRED.
- Click Create.
Parent topic: Setting Up the WebLogic Server Authentication Providers
Updating the Default Authenticator and Setting the Order of Providers
Set the order of identity assertion and authentication providers in the WebLogic Remote Console.
Parent topic: Setting Up the WebLogic Server Authentication Providers
Setting the Default Authenticator
In an Enterprise deployment, your users are stored in an LDAP directory. In order to be able to use the users in the LDAP directory, you must first change the Default Authenticator from REQUIRED to SUFFICIENT.
Use WebLogic Remote Console to connect to and manage the WebLogic Server domain through its Administration Server.
- In the Edit Tree, navigate to Security > Realms > myrealm > Authentication Providers.
- In the navigation tree, select the Default Authenticator.
- Set the Control Flag to SUFFICIENT and click Save.
Adding the Administration Role to the New Administration Group
The adding of administration role to a new administration group enables all users that belong to the group to be administrators for the domain.
Perform the following steps to assign the administration role using the WebLogic Remote Console:
Parent topic: Configuring Single Sign-On for an Enterprise Deployment
Configuring Oracle ADF and OPSS Security with Oracle Access Manager
Some Oracle Fusion Middleware management consoles use Oracle Application
Development Framework (Oracle ADF) security, which can integrate with Oracle Access Manager
Single Sign-on (SSO). These applications can take advantage of Oracle Platform Security
Services (OPSS) SSO for user authentication, but you must first configure the domain-level
jps-config.xml
file to enable these capabilities.
jps-config.xml
file is located in the following
location after you create an Oracle Fusion Middleware
domain:$IAD_ASERVER_HOME/config/fmwconfig/jps-config.xml
Note:
The domain-level jps-config.xml
should not be confused with the jps-config.xml
that is deployed with custom applications.
Parent topic: Configuring Single Sign-On for an Enterprise Deployment