Sun Java System Portal Server 7.1 Configuration Guide

Chapter 6 Installing and Configuring a Gateway With Portal Server

Configuring a gateway to access Portal Server allows you to access Portals using a secure protocol, https. If you have Portal Server installed in an Intranet, you can access Portals from another network through Gateway using Internet. Gateway handles the user requests through the secure protocol.

This chapter includes the following sections:

Configuring Gateway During Installation

This section contains the following procedures:

Figure 6–1 Portal Server with Gateway

The user accesses Portal Server through the gateway.

Configuring a Portal Server and a Gateway on a Single Node

This section describes how to configure a Portal Server and a Gateway on a single node in the Configure Now and Configure Later modes.

Using the Configure Now mode, you can configure a Gateway while installing Portal Server, where the Gateway is configured with other components. You can also configure the Gateway using the Configure Later mode, where you need to manually configure Gateway using the psconfig command after installing Portal Server.

ProcedureTo Configure Portal Server on a Single Node using the Configure Now Mode

  1. Select the Gateway option displayed with Sun Java System Portal Server Secure Remote Access 7.1 when you install Sun Java System Portal Server 7.1.

  2. Enter Directory Server, Access Manager, and web container information in the Java ES installer screens.

  3. Start Directory Server and web container instance after a successful installation of Portal Server.

  4. Start the gateway.

    PortalServer_base/SUNWportal/bin/psadmin switch-sra-status -u admin-user-name -f password-file on

    PortalServer_base/SUNWportal/bin/psadmin provision-sra -u admin-user-name -f password-file --gateway-profile gateway_profile --enable

    PortalServer_base/SUNWportal/bin/psadmin start-sra-instance -u admin-user-name -f password-file -N default -t gateway

ProcedureTo Configure Portal Server on a Single Node using the Configure Later Mode

  1. Select Sun Java System Portal Server 7.1, Directory Server, and web container in the Java ES installer.

  2. Select the Gateway option displayed with Sun Java System Portal Server Secure Remote Access 7.1.

  3. Install the components using the Java ES installer in the Configure Later mode.

  4. Ensure that Directory Server, web container instance, and web container administrator server are running.

  5. Modify the example7.xml file.

    The example7.xml file is located in the PortalServer_base/SUNWportal/samples/psconfig directory.

  6. Configure common agent container.

    PortalServer_base/SUNWportal/bin/psconfig --config example7.xml

  7. Start the Gateway.

    PortalServer_base/SUNWportal/bin/psadmin switch-sra-status -u admin-user-name -f password-file on

    PortalServer_base/SUNWportal/bin/psadmin provision-sra -u admin-user-name -f password-file --gateway-profile gateway_profile --enable

    PortalServer_base/SUNWportal/bin/psadmin start-sra-instance -u admin-user-name -f password-file -N default -t gateway

Configuring Portal Server and Gateway on Separate Nodes

This section describes how to configure Portal Server and Gateway on separate nodes in the Configure Now and Configure Later modes.

Using the Configure Now mode, you can configure a Gateway while installing the Portal Server, where the Gateway is configured with other components. You can also configure the Gateway using the Configure Later mode, where you need to manually configure Gateway using the psconfig command after installing Portal Server.

Ensure that the following ports are opened whenever you configure a Gateway or perform any administrator console or command line operations that involve Gateway.

ProcedureTo Configure Portal Server and Gateway on Separate Nodes in the Configure Now Mode

This procedure requires two nodes: Node 1 and Node 2.

  1. Install Portal Server and Directory Server in the Configure Now mode on Node 1.


    Note –

    Select Enable SRA for Portal while installing the Portal Server.


  2. (Optional) Set SRA status to Enabled on Node 1, if the Enable SRA for Portal is not selected while installing.

    PortalServer_base/SUNWportal/bin/psadmin switch-sra-status -u admin_user -f password_file on

  3. Start the Java ES installer and install Access Manager SDK and Gateway on Node 2 in the Configure Now mode.


    Note –

    Use the same password encryption key on both the nodes.


  4. Enable Gateway profile on Node 1.

    PortalServer_base/SUNWportal/bin/psadmin provision-sra -u admin_user -f password_file --gateway-profile gateway_profile --enable

  5. Start the SRA instance on Node 2.

    PortalServer_base/SUNWportal/bin/psadmin switch-sra-status -u admin-user-name -f password-file on

    PortalServer_base/SUNWportal/bin/psadmin provision-sra -u admin-user-name -f password-file --gateway-profile gateway_profile --enable

    PortalServer_base/SUNWportal/bin/psadmin start-sra-instance -u admin-user-name -f password-file -N default -t gateway

ProcedureTo Configure Portal Server and Gateway on Separate Nodes in the Configure Later Mode

  1. Install Portal Server and Directory Server on Node 1 in the Configure Now mode.

  2. Install AMSDK on Node 2 in the Configure Now mode using the Java ES installer.


    Note –

    Use the same password encryption key on both the nodes.


  3. Install Gateway on Node 2 in the Configure Later mode using the Java ES installer.

  4. Enable Gateway profile on Node 1.

    PortalServer_base/SUNWportal/bin provision-sra -u admin_user -f password_file --gateway-profile gateway_profile --enable

  5. Modify the example10.xml file.

    The example10.xml file is located in the PortalServer_base/SUNWportal/samples/psconfig directory.

  6. Configure common agent container.

    PortalServer_base/SUNWportal/bin/psconfig --config example10.xml

  7. Start the Gateway.

    PortalServer_base/SUNWportal/bin/psadmin switch-sra-status -u admin-user-name -f password-file on

    PortalServer_base/SUNWportal/bin/psadmin provision-sra -u admin-user-name -f password-file --gateway-profile gateway_profile --enable

    PortalServer_base/SUNWportal/bin/psadmin start-sra-instance -u admin-user-name -f password-file -N default -t gateway

ProcedureTo Install Gateway on a Non-Default Instance of Application Server

  1. Install Directory Server and Application Server.

  2. Start Directory Server and Application Server.

  3. Create a node agent.

    asadmin create-node-agent --user admin --password password --savemasterpassword=true node1

  4. Start the node agent.

    ./asadmin start-node-agent --user admin --password password node1

  5. Create non default server instance.

    ./asadmin create-instance --user admin --password password --nodeagent node1 server1

  6. Start the instance.

    ./asadmin start-instance --user admin --password password server1

  7. Install Access Manager in the Configure Later mode.

  8. Edit the amsamplesilent file.

  9. Restart Directory Server, Application Server, and Access Manager.

  10. Check if Access manager is up and running.

  11. Invoke installer and install Portal Server in the Configure Later mode.

  12. Edit the example14.xml file and configure common agent container.

    ./psconfig --config example14.xml

Installing the Gateway with Portal Server in the SSL Mode

Installing the Gateway with Portal Server in SSL mode allows the user, in the same Intranet where Portal Server is installed, to access Portals through a secure protocol.

Figure 6–2 Portal Server in the SSL mode

The user accesses Portal Server through the gateway.

ProcedureTo Install Gateway with Portal Server in SSL

  1. Import the root Certificate Authority (CA) to the certificate database.


    cd /usr/jdk/entsys-j2se/jre/lib/security
    /usr/jdk/entsys-j2se/jre/bin/keytool -keystore
    cacerts -keyalg RSA -import -trustcacerts -alias
    alias-name -storepass store-password -file
    file-name-path
    
  2. Start the Java ES installer and install the Gateway and Access Manager SDK.

  3. Create a certificate signing request.

    1. Run the following command:

      PortalServer_base/SUNWportal/bin/certadmin -n default

    2. Select Option 2 in the command-line interface.

    3. Type the details and save the certificate request in a file.

  4. Get this certificate signed by the Certificate Authority.

    The Certificate Authority will be the Portal Server Administrator.

  5. Create a file on the Gateway node, and paste the certificate response.

  6. Add the signed certificate to the certificate database of Gateway.

    1. Run the following command:

      PortalServer_base/SUNWportal/bin/certadmin -n default

    2. Select Option 4 in the command-line interface.

  7. Add the Root Certificate Authority to the certificate database.

    1. Run the following command:

      PortalServer_base/SUNWportal/bin/certadmin -n default

    2. Select Option 3 in the command-line interface.

    3. Provide the path for the Root Certificate Authority.

      The following message is displayed, “Successfully added.”

  8. Restart the Gateway.

    PortalServer_base/SUNWportal/bin/psadmin switch-sra-status -u admin-user-name -f password-file on

    PortalServer_base/SUNWportal/bin/psadmin provision-sra -u admin-user-name -f password-file --gateway-profile gateway_profile --enable

    PortalServer_base/SUNWportal/bin/psadmin start-sra-instance -u admin-user-name -f password-file -N default -t gateway

Creating a Gateway Instance

You can also create an instance of Gateway. This allows the user to contact any one of the Gateway instances and access Portals.

ProcedureTo Create a Gateway Instance

  1. Log in to Portal Server administrator console.

  2. Click the Secure Remote Access tab.

  3. Click New Profile.

  4. Type the new profile name and select the Copy Profile Data From option. Click OK.

    The following message is displayed: “New profile is successfully created. Please change the relevant ports in the new profile so that they do not clash with those in the existing profiles.”

  5. Click OK.

    The Profile screen is displayed.

  6. Click the new profile created and change the port of the instance so that it does not clash with any ports that are in use.

    You need to change both the http and https port numbers.

  7. Click OK.

Configuring Personal Digital Certificate (PDC) Authentication

This section describes how to configure a digital certificate for a Gateway.

ProcedureTo Configure Personal Digital Certificate Authentication

Before You Begin
  1. Edit the AMConfig.properties file on the Portal Server node.

    The AMConfig.properties file is located in the AccessManager_base/SUNWam/config directory.

    1. Add the following line in the AMConfig.properties file.

      com.iplanet.authentication.modules.cert.gwAuthEnable=yes

  2. Import the certificates to the certificate database of the Gateway.

  3. Import the Root Certificate Authority on the Gateway machine.

  4. Add the Root Certificate Authority to the Gateway profile.

    1. Run the following command:

      PortalServer_base/SUNWportal/bin/certadmin -n gateway-profile-name

    2. Select Option 3 in the command-line interface.

      You are prompted to provide the certificate path. When you provide a valid path, the certificate is added. You will get a message that the certificate is added successfully.

  5. Generate a Certificate Signing Request for submitting to the Certificate Authority.

    1. Run the following command:

      PortalServer_base/SUNWportal/bin/certadmin -n gateway-profile-name

    2. Select Option 2 in the command-line interface.

    3. Enter values when prompted.

    4. Save the request in a file.

  6. Submit the Certificate Signing Request to a Certificate Authority and get it approved.

  7. Save the certificate response on a file after Certificate Authority has signed it.

  8. Import the certificate response file.

    1. Run the following command:

      PortalServer_base/SUNWportal/bin/certadmin -n gateway-profile-name

    2. Select Option 4 in the Certadmin menu.

    3. Provide the location of the certificate response file.

  9. Import the Root CA certificate on the Portal Server machine.


    ./certutil -A -n rootca -t "TCu,TCu,TCuw" 
    -d /var/opt/SUNWappserver/domains/domain1/config
     -a -i rootca-path
    
  10. Register Certificate as an Authentication module.

    1. Log in to amconsole as the administrator.

    2. Click the Identity Management tab.

    3. Select the Organization.

    4. Select Services in the View drop-down list.

    5. Verify whether the Certificate is displayed in the left pane under the Authentication Modules option.

    6. Click Add if the Certificate Service is not displayed in the left pane.

    7. Select Certificate in the right pane.

      Certificate is displayed under the Authentication Modules option.

    8. Click OK.

      Certificate is displayed under the Authentication Modules option in the left pane.

  11. Allow Certificate Authentication to trust any remote host.

    1. Log in to amconsole as the administrator.

    2. Click the Identity Management tab.

    3. Select the Organization.

    4. Select Services in the View drop-down list.

    5. Click the Arrow button displayed with the Certificate option.

    6. Select the None option displayed in the Trusted Remote Hosts list box.

    7. Click Remove.

    8. Type Any in the text box displayed with the Trusted Remote Hosts list box.

    9. Click Add, and click Save in the right panel.

  12. Add Certificate as a required enforcement criterion.

    1. Log in to amconsole as the administrator.

    2. Click the Identity Management tab.

    3. Select the Organization.

    4. Select Services in the View drop-down list.

    5. Click the Arrow button that is displayed with the Authentication Configuration option.

      The Service Instance screen appears.

    6. Click New in the Service Instance screen.

      The New Service Instance List screen appears.

    7. Enter the service instance name as gatewaypdc.

    8. Click Submit.

      The Service Instance List screen appears.

    9. Click gatewaypdc option.

      The gatewaypdc Show Properties screen appears.

    10. Click the Edit link.

    11. Click Add.

      The Add Authentication Modules pop-up window appears.

    12. Select Cert as the Module Name.

    13. Select Required for Enforcement Criteria.

    14. Click OK.

      The Authentication Modules pop-up window appears.

    15. Click OK and close the pop-up window.

  13. Add a dynamic user.

    1. Log in to amconsole as the administrator.

    2. Click the Arrow button displayed with Core option in the Identity Management tab.

    3. Select gatewaypdc in the Organization Authentication Modules list box.

    4. Select Dynamic from the User Profile drop-down list.

    5. Click Save.

  14. Add Gateway host in the Portal Server administration console.

    1. Log in to Portal Server administration.

    2. Click Secure Remote Access.

    3. Click the Gateway profile.

      The Profile screen appears.

    4. Click the Security tab.

      The Security Options screen appears.

    5. Add the Gateway host name in the Certificate-enabled Gateway Hosts list box.

    6. Click Add and click Save.

  15. Restart the server.


    Note –

    This is mandatory because the Amconfig.Properties is updated.


  16. Restart the Gateway profile.

  17. Install the client certificate issued by the Certificate Authority into the browser.

    Access the PDC enabled Gateway.

  18. Install the client certificate to the JVM keystore.

    1. Click Start > Settings > Control Panel > Java.

    2. Add the following parameters in the Applet Run Time parameters:


      -Djavax.net.ssl.keyStore=keystore-path
       -Djavax.net.ssl.keyStorePassword=password
       -Djavax.net.ssl.keyStoreType=type
      
  19. Add portal services to the dynamic user created.

    1. Log in to Access Manager administrator console as the administrator.

    2. Click the Identity Management tab.

    3. Select the Organization.

    4. Select Users in the View drop-down list.

    5. Add Services to the dynamic user created.

  20. Add a dynamic user to the Distinguished Name (DN).

    1. Log in to the Portal Server administrator console.

    2. Click Portals > Portal name.

    3. Add the dynamic user to the DN.

    4. Change the Parent Container to JSPTabContainer.

    5. Change Desktop Type of the user to developer_sample, enterprise_sample, or community_sample.

Installing Load Balancer Plugin and Gateway for Portal Server

This section explains how to install Load Balancer Plugin and Gateway for Portal Server. A Load Balancer handles multiple Portal Server instances. If any one of the Portal Server instances goes down, the Load Balancer automatically redirects the user to the other available Portal Server instance.

A Load Balancer can be installed behind the Gateway or in front of the Gateway. If the Load Balancer is installed behind the Gateway, the user accesses the Portal Server instances through the Gateway. The end user contacts the Gateway. If the Load Balancer is installed in front of the Gateway, the user accesses the Portal Server instances through the Load Balancer.

Figure 6–3 Portal Server with Load Balancer

Portal Server Instances with Gateway in front of the
Load Balancer. The user accesses the gateway.

This section explains the following:

ProcedureTo Install Load Balancer Plugin for Portal Server

This task requires the following:

  1. Install the Load Balancer plugin that is available with the Application Server using the Java ES installer.


    Note –

    Select Web Server as a component to install with the Load balancer plugin.


  2. Edit the Loadbalancer.xml file.

    The Loadbalancer.xml file is located in the WebServer_base/SUNWwbsvr/https-node3/config/Loadbalancer.xml directory.

    A sample Loadbalancer.xml file is displayed as follows:


    <!DOCTYPE Load Balancer PUBLIC "-//Sun Microsystems Inc.
    //DTDSun ONE Application Server 7.1//EN"
    "sun-Load Balancer_1_1.dtd">
    <Load Balancer>
    <cluster name="cluster1">
    <!--
    Configure the listeners as space seperated URLs like
    listeners="http://host:port https://host:port" For example:
    <instance name="instance1" enabled="true"
    disable-timeout-in-minutes="60"
    listeners="http://node1.domain-name:80"/>
    <instance name="instance1" enabled="true"
    disable-timeout-in-minutes="60"
    listeners="http://node2.domain-name:80"/>
    -->
    <instance name="instance1" enabled="true"
    disable-timeout-in-minutes="60"
    listeners=""/>
    <web-module context-root="/portal" enabled="true"
    disable-timeout-in-minutes="60"
    error-url="sun-http-lberror.html" />
    <web-module context-root="/psconsole" enabled="true"
    disable-timeout-in-minutes="60"
    error-url="sun-http-lberror.html" />
    <health-checker url="/" interval-in-seconds="10"
    timeout-in-seconds="30" />
    </cluster>
    <property name="reload-poll-interval-in-seconds"
    value="60"/>
    <property name="response-timeout-in-seconds"
    value="30"/>
    <property name="https-routing" value="true"/>
    <property name="require-monitor-data" value="false"/>
    <property name="active-healthcheck-enabled"
    value="false"/>
    <property name="number-healthcheck-retries"
    value="3"/>
    <property name="rewrite-location" value="true"/>
    </Load Balancer>
  3. Restart the Web Server and access Portal through the Load Balancer.

ProcedureTo Install Gateway in Front of the Load Balancer

This procedure requires three nodes: Node 1, Node 2, and Node 3.

In this procedure, you do the following:

  1. Install Portal Server with Secure Remote Access, Directory Server, Access Manager, and Application Server on Node 1.

  2. Install Load Balancer on Node 2.

    Load Balancer plugin is available with Application Server 8.2.


    Note –

    Select Web Server as a component to install with Load Balancer.


  3. Log in to Access Manager administration console on Node 1.

    http://node1:8080/amconsole

    1. Select Services in the in the View drop-down list.

    2. Click Administration.

    3. Add Load Balancer Fully Qualified Domain Name in the organization aliases.

      http://node2.domain-name:8080

    4. Add the Load Balancer URL in the platform service.

      http://node1.domain-name:8080|01

    5. Click Core.

    6. Change Default Success Login URL to http://node1.domain-name:8080/portal/dt from http://node2.domain-name:8080/portal/dt.

  4. Edit the AMConfig.properties file.

    The AMConfig.properties file is located in the AccessManager_base/SUNWam/Config directory.

    1. Change com.sun.identity.server.fqdnMap LB-FQDN]=LB-FQDN line in the AMConfig.properties file with the fully qualified domain name of Load Balancer.

  5. Restart Portal Server and Application Server on Node 1.

  6. Log in to Access Manager administrator console and Portal through the Load Balancer.

    http:node2.dommain-name:8080/amconsole

    http:node2.dommain-name:8080/portal/dt

  7. Install Gateway on Node 3.

  8. Provide appropriate Portal Server, Access Manager, and Directory Server values in the Installation panels.


    Note –

    Do not provide any values of the Load Balancer.


    The Gateway is installed successfully.

    Gateway can be installed in the Configure Later mode also. Change the example10.xml file. Set the PortalAccessURL as the Load Balancer URL. Set the PrimaryPortalHost as the portal where the first portal is installed. This is used to set up trust between two common agent containers. After modifying the example10.xml file, run the psconfig command to configure Portal Server.

  9. Configure the Gateway to direct to the Load Balancer instead of Portal Server on Node 3.

    1. Set ignoreServerList=true in the platform.conf.default file.

      The platform.conf.default file is located in the PortalServer_base/SUNWportal directory.

    2. Replace Portal host and port information with Load Balancer host and port in the platform.conf.default file.

      The platform.conf.default file is located in the PortalServer_base/SUNWportal directory.

    3. Replace Portal host and port information with Load Balancer host and port in the AMConfig-default.properties file on Node 3.

      The AMConfig-default.properties file is located in the AccessManager_base/SUNWam directory.

    4. Log in to Portal Server administrator console.

      http://node1.domain-name:8080/psconsole

    5. Click Secure Remote Access > gw448.

    6. Enter the Load Balancer URL in the Portal Server(s) list displayed in the right panel.

      http://node2.domain-name:8080

    7. Add the Load Balancer URL in the URLs to which User Session Cookie is Forwarded list.

    8. Click the Security tab.

    9. Add the Load Balancer URL for Access Manager console and Access Manger server in the Non-authenticated URLs list.

      http://node2.domain-name:8080/amconsole

      http://node2.domain-name:8080/amserver

    10. Configure the enableSRAforPortal.xml file.

      PortalServer_base/SUNWportal/bin/psadmin provision-sra enableSRAforPortal.xml

  10. Restart Gateway.

Installing and Creating Instances of Netlet and Rewriter Proxies

This section explains how to install Netlet Proxy and Rewriter Proxy. This section also explains how to create a second instance of Netlet and Rewriter proxies using the psadmin command.

This section includes the following:

ProcedureTo Install Netlet Proxy in the Configure Now Mode

  1. Invoke the Java ES installer.

  2. Select Netlet Proxy in the Components Selection screen and proceed with the installation.

  3. Specify the Host IP Address, Access Port (default: 10555), and the Profile Name to which the Netlet Proxy instance needs to be associated in the Portal Server: Secure Remote Access: Configure Netlet Proxy panel.

  4. Verify whether the Netlet Proxy instance is running.

    netstat -an | grep PORT

ProcedureTo Install Netlet Proxy in the Configure Later Mode

  1. Install Netlet Proxy in the Configure Later mode using the Java ES installer.

  2. Modify the example11.xml with the appropriate values.

    The attributes within <NetletPoxy profile=profilename>...</NetletProxy> tags need to be changed.

  3. Configure example11.xml.

    PortalServer_base/SUNWportal/bin/psconfig --config example11.xml

  4. Start Netlet Proxy.

ProcedureTo Create a Second Instance of Netlet Proxy Using the psadmin Command

  1. Install Netlet Proxy in the Configure Later mode using the Java ES installer.

  2. Configure common agent container by modifying the example2.xml file.

  3. Configure the common agent container.

    PortalServer_base/SUNWportal/bin/psconfig --config example2.xml

  4. Copy the NLPConfig.properties.template file to a temporary location.

    cp PortalServer_base/SUNWportal/template/sra/NLPConfig.properties.template /tmp

  5. Modify the values for an existing profile.

  6. Create a Netlet Proxy instance.

    psadmin create-sra-instance -u admin-user-name -f PASSWORDFILE -S /tmp/NLPConfig.properties.template -t nlproxy

  7. Start Netlet Proxy.

ProcedureTo Install Rewriter Proxy in the Configure Now mode

  1. Invoke the Java ES installer.

  2. Select Rewriter Proxy in the Components Selection screen, and proceed with the installation.

  3. Specify the Host IP Address, Access Port (default: 10443), and the Profile Name to which this Rewriter Proxy instance needs to be associated in the Portal Server: Secure Remote Access: Configure Rewriter Proxy screen.

  4. Check whether the Rewriter Proxy instance is running:

    netstat -an | grep PORT

ProcedureTo Install Rewriter Proxy in the Configure Later Mode

  1. Install Rewriter Proxy in the Configure Later mode using the Java ES installer.

  2. Modify the example11.xml file with the appropriate values.

    The attributes within the <RewriterPoxy profile=profilename>...</RewriterProxy> tags need to be changed for Rewriter proxy.

  3. Configure the common agent container.

    PortalServer_base/SUNWportal/bin/psconfig --config example11.xml

  4. Start Rewriter Proxy.

ProcedureTo Create a Second Instance of Rewriter Proxy Using the psadmin Command

  1. Install Rewriter Proxy in Configure Later mode using the Java ES installer.

  2. Configure common agent container by modifying the example2.xml file.

    PortalServer_base/SUNWportal/bin/psconfig --config example2.xml

  3. Copy the RWPConfig.properties.template file to a temporary location.

    cp PortalServer_base/SUNWportal/template/sra/RWPConfig.properties.template /tmp

  4. Modify the values for an SRA profile.

  5. Create a Rewriter Proxy.

    PortalServer_base/SUNWportal/bin/psadmin create-sra-instance -u admin-user-name -f PASSWORDFILE -S /tmp/RWPConfig.properties.template -t rwproxy

  6. Start Rewriter Proxy.