Configure WebSphere Portal for Sun ONE with realm support

 

Overview

Follow these steps to edit the wpconfig.properties file and run the appropriate configuration tasks so that WebSphere Portal can work with the LDAP server.

A configuration template might exist to support these instructions. Refer to the...

wp_root/config/helpers

...directory for available templates. Use the configuration template to update the wpconfig.properties file, according to the property descriptions and recommended values provided below. If you do not want to use a configuration template, simply follow the instructions below as written.

These steps allow you to configure your LDAP server to use virtual portal and realm support.

For security reasons, not store passwords in the wpconfig.properties file. It is recommended that you edit the wpconfig.properties prior to running a configuration task, inserting the passwords needed for that task. Then, after the task has run, you should delete all passwords from the wpconfig.properties file.

Alternatively, you can specify the password on the command line using the following syntax:

WPSconfig.sh task_name -Dpassword_property_key=password_value

As with other properties, each password property must have the -D prefix and be set equal to (=) a value. If you have multiple properties in a single command, use a space character between each -Dproperty=value setting.

 

Steps for this task

  1. Ensure that the LDAP software is installed and any setup required by WebSphere Portal has been performed.

  2. Locate the wpconfig.properties file and create a back up copy before changing any values.

    wp_root/config/wpconfig.properties

  3. Use a text editor to open the wpconfig.properties file and enter the values appropriate for your environment.

    Property Value
    WasUserid The user ID for WAS security authentication. This should be the fully qualified distinguished name (DN). For LDAP configuration this value should not contain spaces.

    Note that if a value is specified for WasUserid, a value must also be specified for WasPassword. If WasUserid is left blank, WasPassword must also be left blank.

    Recommended value: uid=wpsbind,ou=people,o=setgetweb.com

    Default LDAP value: ReplaceWithYourWASUserId

    WasPassword The password for WAS security authentication.

    Note that if a value is specified for WasPassword, a value must also be specified for WasUserid. If WasPassword is left blank, WasUserid must also be left blank.

    Recommended value: <none>

    Default value: ReplaceWithYourWASUserPwd

    Section of properties file: Portal configuration properties

    Property Value
    PortalAdminId The user ID for the WebSphere Portal administrator. This should be the fully qualified distinguished name (DN).

    For LDAP configuration this value should not contain spaces.

    Recommended value: uid=portaladminid,ou=people,o=setgetweb.com

    Default LDAP value: uid=<portaladminid>,o=default organization

    PortalAdminIdShort The short form of the user ID for the WebSphere Portal administrator, as defined in the PortalAdminId property.

    Recommended value: <none>

    Default value: <portaladminid>

    PortalAdminPwd The password for the WebSphere Portal administrator, as defined in the PortalAdminId property.

    Recommended value: <none>

    Default value: <none>

    PortalAdminGroupId The group ID for the group to which the WebSphere Portal administrator belongs.

    Recommended value: cn=wpsadmins,ou=groups,o=setgetweb.com

    Default value: cn=wpsadmins,o=default organization

    PortalAdminGroupIdShort The short form of the group ID for the WebSphere Portal administrator, as defined in the PortalAdminGroupId property.

    Recommended value: <none>

    Default value: wpsadmins

    WpsContentAdministrators The group ID for the WebSphere Content Administrator group.

    Default value: cn=wpsContentAdministrators,ou=groups,o=setgetweb.com

    Default value: cn=wpsContentAdministrators,o=default organization

    WpsContentAdministratorsShort The WebSphere Content Administrators group ID.

    Recommended value: <none>

    Default value: wpsContentAdministrators

    WpsDocReviewer The group ID for the WebSphere Document Reviewer group.

    Recommended value: cn=wpsDocReviewer,ou=groups,o=setgetweb.com

    Default value: cn=wpsDocReviewer,o=default organization

    WpsDocReviewerShort The WebSphere Document Reviewer group ID.

    Recommended value: wpsDocReviewer

    Default value: wpsDocReviewer

    Section of properties file: Database properties

    Property Value
    DbUser The user ID for the database administrator.

    Recommended value: <none>

    Default value: db2admin

    DbPassword The password for the database administrator.

    Recommended value: <none>

    Default value: ReplaceWithYourDbAdminPwd

    Section of properties file: WebSphere Portal Security LTPA and SSO configuration

    Property Value
    LTPAPassword The password for the LTPA bind.

    Recommended value: <none>

    Default value: <none>

    LTPATimeout Specifies the number of minutes after which an LTPA token will expire.

    Recommended value: 120

    Default value: 120

    SSODomainName Specifies the domain name for all allowable single signon host domains.

    • Enter the part of the domain that is common to all servers that participate in single signon. For example, if WebSphere Portal has the domain portal.us.ibm.com and another server has the domain another_server.ibm.com, enter ibm.com.

    • To specify multiple domains, use a semicolon ; to separate each domain name. For example, your_co.com;ibm.com.

    SSO is achieved via a cookie that is sent to the browser during authentication. When connecting to other servers in the TCP/IP domain specified in the cookie, the browser sends the cookie. If no domain is set in the cookie, the browser will only send the cookie to the issuing server.

    Recommended value: your company's domain name

    Default value: <none>

    Section of properties file: LDAP Properties Configuration

    Property Value
    Lookaside Specifies if a Lookaside database is to be used in combination with the LDAP server. A Lookaside database stores attributes which cannot be stored in your LDAP server. This combination of LDAP plus a Lookaside database is needed to support Member Manager, however, using a Lookaside database can slow down performance.To enable the LDAP + Lookaside database combination, set this property to true.

    This value cannot be configured after security is enabled. If you intend to use a Lookaside database, set this value before configuring security.

    Recommended value: false

    Default value: false

    WmmDefaultRealm The default realm of the Member Manager user registry (UR) configuration. Set this property before enabling security with enable-security-wmmur-ldap or enable-security-wmmur-db.

    Recommended value: portal

    Default value: portal

    LDAPHostName The host information for the LDAP server that WebSphere Portal will use; for example, yourserver.setgetwebmpany.com.

    Recommended value: <none>

    Default value: yourldapserver.com

    LDAPPort The server port of the LDAP directory.

    Recommended value (non-SSL): 389

    Recommended value (SSL): 636

    Default value: 389

    LDAPAdminUId The LDAP administrator id.

    Recommended value: <none>

    Default value: cn=root

    LDAPAdminPwd The password for the LDAP directory administrator, as defined in the LDAPAdminUId property. If the LDAPAdminUId is blank, this property must be blank as well.

    Recommended value: <none>

    Default value: <none>

    LDAPServerType Type of LDAP Server to be used.

    Recommended value: IPLANET

    Default value: IBM_DIRECTORY_SERVER

    WmmSystemId The fully-qualified distinguished name (DN) of a user in the LDAP. This DN is stored in the credential vault for PUMA's use to access the Member Manager EJB. The Member Manager EJB is secured by WAS Security starting with WebSphere Portal 5.1. An authenticated security context is now established before WebSphere Portal can access Member Manager.

    This value should not contain spaces and must not contain any suffixes in the custom user registry case.

    Recommended value: uid=wmmsystemid,ou=people,o=setgetweb.com

    Default value: <none>

    WmmSystemIdPassword Password for WmmSystemId.

    Recommended value: <none>

    Default value: <none>

    Section of properties file: Advanced LDAP Configuration

    Property Value
    LDAPSuffix The LDAP Suffix. Choose a value appropriate for your LDAP server. This is the distinguished name (DN) of the node in the LDAP containing all user and group information for the Portal being configured. As such, it is the lowest container in the LDAP tree still containing all users that will log into the Portal and all Portal groups.

    If WAS configuration tasks (e.g., enable-security-ldap) are used to activate WAS Security, this value will be used as the single Base Distinguished Name for the Application Server LDAP configuration. This value will be qualified with the LDAPUserSuffix and LDAPGroupSuffix values in order to configure Member Manager.

    Recommended value: o=setgetweb.com

    Default value: dc=setgetweb,dc=com

    LdapUserPrefix RDN prefix attribute name for user entries.

    Recommended value: uid

    Default value: uid

    LDAPUserSuffix The DN suffix attribute name for user entries. Choose the value appropriate for your LDAP server. With the "LDAPSuffix" appended to this value, it is the DN of the common root node in the LDAP containing all user information for the Portal being configured. As such, it is the lowest container in the LDAP tree still containing all users that will log into the Portal including the Portal admin users (e.g., wpsadmin and wpsbind).

    Recommended value: ou=people

    Default value: cn=users

    LdapGroupPrefix RDN prefix attribute name for user entries.

    Recommended value: cn

    Default value: cn

    LDAPGroupSuffix The DN suffix attribute name for group entries. Choose a value appropriate for your LDAP server. With the "LDAPSuffix" appended to this value, it is the DN of the common root node in the LDAP containing all group information for the Portal being configured. As such, it is the lowest container in the LDAP tree still containing all group entries for the Portal including the Portal admin group (e.g., wpsadmins).

    Recommended value: ou=groups

    Default value: cn=groups

    LDAPUserObjectClass The LDAP object class of the Portal users in your LDAP directory that will log into the Portal being configured.

    Recommended value: inetOrgPerson

    Default value: inetOrgPerson

    LDAPGroupObjectClass The LDAP object class of all the groups in your LDAP directory that the Portal will access.

    Recommended value: groupOfUniqueNames

    Default value: groupOfUniqueNames

    LDAPGroupMember The attribute name in the LDAP group object of the "membership" attribute. Choose a value appropriate for your LDAP server.

    Recommended value: uniqueMember

    Default value: uniqueMember

    LDAPsslEnabled Specifies whether secure socket communications is enabled to the LDAP server.

    Recommended value (non-SSL): false

    Recommended value (SSL): true

    Default value: false

  4. Optional: If you installed WAS as part of the WebSphere Portal installation and you plan to use WAS single signon, ensure that the following property in the wpconfig.properties file has the recommended value and not the default value. WebSphere Portal uses Form-based login for authentication, which requires SSO to be enabled; otherwise, you will be no longer able to login to WebSphere Portal.

    If you installed WebSphere Portal onto a pre-existing instance of WAS, skip this step. Any pre-existing settings for WAS SSO are automatically detected and preserved when you run the appropriate task to configure security.

    Section of properties file: WebSphere Portal Security LTPA and SSO Configuration

    Property Value
    SSORequiresSSL Specifies that single signon is enabled only when requests are over HTTPS SSL connections. Choose False unless SSL is already enabled for WebSphere Portal. In most cases, SSL for WebSphere Portal will not yet be in place. After SSL for WebSphere Portal is set up, change this value using the WAS administrative console.

    Recommended value (non-SSL): false

    Recommended value (SSL): true

    Default value: false

  5. Save the file.

  6. In a command prompt, change to the WAS /bin directory.

      was_root/bin

  7. Enter the following commands:

    1. startServer server1

    2. stopServer WebSphere_Portal

  8. Change to the WebSphere Portal configuration directory.

      wp_root/config

  9. Enter the following command... 

    ./WPSconfig.sh validate-wmmur-ldap \
              -DWasPassword=password \
              -DPortalAdminPwd=password \
              -DLTPAPassword=password \
              -DLDAPAdminPwd=password \
              -DWmmSystemIdPassword=password \
    If the configuration task fails, validate the values in the wpconfig.properties file.

  10. Follow these steps if you are running this task on a node that is already federated and have not previously used this step to copy Member Manager files to the deployment manager:

    1. Run the following command which to create...

      wp_root/config/work/wasextarchive.jar

      ...which contains the Member Manager binaries...

      ./WPSconfig.sh archive-was-ext

    2. Copy wasextarchive.jar file from wp_root/config/work directory to the installation root folder of the WebSphere Portal Network Deployment Manager, for example Dmgr_root.

    3. Stop WebSphere Portal Network Deployment Manager by issuing the following command from the Dmgr_root/bin directory:

      • UNIX:        ./stopManager.sh

      • Windows:  stopManager.bat

    4. Un-archive the wasextarchive.jar file in the Dmgr_root directory using the following command from the Dmgr_root directory:

      • UNIX:        ./java/bin/jar -xvf wasextarchive.jar

      • Windows:  \java\bin\jar -xvf wasextarchive.jar

    5. Verify that the Dmgr_root/lib/ext directory contains files that start with the word wmm.

    6. Start WebSphere Portal Network Deployment Manager by issuing the following command from the Dmgr_root/bin directory:

      • UNIX:        ./startManager.sh

      • Windows:  startManager.bat

  11. If you meet either of the following criteria:

    • You installed WebSphere Portal on a pre-existing instance of WAS which did not have Global Security enabled

    • You installed WAS as part of the WebSphere Portal installation

    Enter the appropriate command to run the configuration task for your specific operating system:

    If this is a cluster environment, stop all cluster members before enabling security using the enable-security-wmmur-ldap task.

  12. Check the output for any error messages before proceeding with any additional tasks. If the configuration task fails, verify the values in the wpconfig.properties file. Before running the task again, be sure to stop the WebSphere Portal appserver. Follow these steps to stop the server:

    1. In a command prompt, change to the WAS /bin directory.

        was_root/bin

    2. Enter the following command and specify the WAS user ID and password (as defined by the WasUserid and WasPassword properties):

      stopServer WebSphere_Portal -user was_admin_userid -password was_admin_password

  13. If you are using LDAP over SSL, refer to Set up LDAP over SSL and be sure your LDAP is properly configured.

  14. Stop and start the servers.

    1. In a command prompt, change to the WAS /bin directory.

        was_root/bin

    2. Enter the following commands. If you are running with security enabled on WAS, specify a user ID and password for security authentication when entering the commands.

      1. Stop server 1.

        • stopServer server1

        • Security enabled: stopServer server1 -user was_admin_userid -password was_admin_password

      2. Start server 1.

      3. Start WebSphere Portal appserver

  15. If you installed WebSphere Portal on a pre-existing instance of WAS. Manually deploy portlets if you installed WebSphere Portal without configuring it during installation:

    1. Ensure that WebSphere Portal is running.

    2. In a command prompt, change to the WebSphere Portal /config directory.

        wp_root/config

    3. Run the configuration task for your specific operating system:

      • UNIX: ./WPSconfig.sh portlets -DPortalAdminPwd=password

      • Windows: WPSconfig.bat portlets -DPortalAdminPwd=password

  16. If you installed WebSphere Portal into a pre-existing SSO environment. Because you will not be given the option to import your existing token file, perform the following steps:

    • To import your SSO Token:

      1. In the WAS Administrative Console, select...

        Security > Authentication Mechanisms > LTPA

      2. Enter the LTPA token password in the Password field.

      3. Enter the password again in the Confirm password field.

      4. In the Key File Name field, enter the LTPA token file.

      5. Click Import Keys.

      6. Click Save.

    • To set your SSO Domain:

      1. In the WAS Administrative Console, select Security > Authentication Mechanisms > LTPA.

      2. Click Single Signon in Additional Properties.

      3. Enter the domain name in the Domain Name field.

      4. Click OK.

  17. If you want to allow users or portal administrators to create and modify directory attributes through self-registration and self-care screens or the user management portlet. Perform the following steps:

    1. Edit...

      wp_root/shared/app/config/services/PumaService.properties

    2. Add user.sync.remove.attributes=cn,CN.

    3. Save the file.

    4. Restart the WebSphere_Portal appserver.

    5. Note that if you do not perform these steps WebSphere Portal will not be able to create or update a user by using portal functions because of a misconfiguration.

    WebSphere Portal can be configured to create the distinguished name (DN) for a user account created through WebSphere Portal interfaces (self-registration or the user management portlet create new user functions) by using the common name (cn) as the first Relative Distinguished Name (RDN) component. The default configuration of WebSphere Portal generates this attribute based on the surname and givenname attribute. The configuration is located in the puma.properties file

    The following entry defines the user common name pattern and can be used to customize common name. In the pattern, you can define which attribute is used. Therefore the maximum amount of attributes has to be provided by puma.commonname.parts. For example... 

    eg: firstname+" "+lastname
    puma.commonname = {0} {1}
    puma.commonname.parts = 2
    puma.commonname.0 = firstname
    puma.commonname.1 = lastname

 

Verifying configuration

Access WebSphere Portal via http://hostname.setgetweb.com:port_number/wps/portal and verify that you can log in.

Configuring WebSphere Portal to work with an LDAP directory automatically enables WAS Global Security. Once security is enabled, type the fully qualified host.name when accessing WebSphere Portal and the WAS Administrative Console.

 

Security is enabled

Once you have enabled security with your LDAP directory, provide the user ID and password required for security authentication on WAS when you perform certain administrative tasks with WAS. For example, to stop the WebSphere Portal appserver, you would issue the following command: 

stopServer WebSphere_Portal -user was_admin_userid -password was_admin_password

 

Switching the login LDAP attribute

Follow these steps to switch the login LDAP attribute from the default (uid) to another LDAP attribute (such as emailAddress):

  1. Open the WAS AdminConsole.

  2. Go to...

    Security | User Registries | Custom | Custom Properties

  3. If wmmUserSecurityNameAttr already exists, select it. Otherwise click New.

  4. If not already set, set Name as wmmUserSecurityNameAttr and Value to the attribute you would like, such as emailAddress.

    Attribute names are found in...

    wp_root/wmm/wmmLDAPServerAttributes.xml

  5. Save your changes.

  6. Open the file wp_root/wmm/wmm.xml.

  7. Set userSecurityNameAttribute to the attribute you would like to be used as login the attribute (using the example in Step 4, the setting would look like: userSecurityNameAttribute="emailAddress".)

  8. Save the file and restart PortalServer.

 

Next steps

You have completed this step. Continue to the next step by choosing the following topic:

 

WebSphere is a trademark of the IBM Corporation in the United States, other countries, or both.

 

IBM is a trademark of the IBM Corporation in the United States, other countries, or both.