Download

 API Gateway Readme

Axway API Gateway 7.5.2 SP 4 Readme

Document version: 2 June 2017


Readme for 7.5.2 SP 4

This Readme applies to Axway API Gateway 7.5.2 SP 4, for all platforms. The information in this Readme supersedes any corresponding information in the documentation (online or printed) previously supplied for the product.

The main aim of this service pack is to provide fixes for a number of reported defects. This service pack contains updates for:

  • API Gateway Core Server
  • API Gateway Analytics
  • Policy Studio
  • Configuration Studio

The service pack contains new binaries only and does not overwrite the existing configuration.

File packages: An installation archive is provided for all platforms (for example, APIGateway_7.5.2_SP4_Core_win-x86-32_BNYYYYMMDDn.zip for Windows).

Size: The file size differs for each platform. The MD5 checksum is provided for each file.

Fixed issues

Fixed security vulnerabilities

Internal ID Case ID CVE ID Description
RDAPI-9053 00888175 CVE‑2017‑3241

Issue: Security vulnerability in JRE version.

Resolution: Previously, API Gateway used JRE version that included a security vulnerability. Now, the JRE version has been updated to v8u131 that fixes this vulnerability.

RDAPI-9097 00894936 CWE-285

Issue: Failure when revoking refresh token if access token has expired.

Resolution: Previously, if you tried to revoke a OAuth refresh token after its associated access token had expired, the revoke failed with a wrong error unauthorized_client. Now, you can revoke a refresh token even if the access token has expired, and failed attempts are reported as invalid_request.

Other fixed issues

Internal ID Case ID Description
RDAPI-8826 00890617

Issue: Duplicate elements in the array output in Visual Mapper data maps.

Resolution: Previously in Policy Studio, if you used a Visual Mapper data map to map JSON input to JSON output including arrays, some array elements were duplicated. Now, the content is generated correctly for the arrays, and the array elements are no longer duplicated.

After installing this service pack, you must re-generate your data maps to apply this fix to them:

  1. Open a data map for editing.
  2. Delete a link.
  3. Draw the same link again, and save the map.
RDAPI-8859 00888407 Issue: Policy references incorrect after copying a policy container.
Resolution: Previously in Policy Studio, when you copied a policy container that referenced other policies in the same container, the policy references in the Policy Shortcut and Policy Shortcut Chain filters were not updated to point to the new copy of the container. Instead, the policy references continued to point to the original container.
Now, the original behavior has been restored. When you copy a policy container, the policy references are updated to point to the new container, not the original container.
RDAPI-8930 00889541 Issue: HTTP responses containing intermediary HTTP 100 Continue responses not displayed correctly in Traffic Monitor log.
Resolution: Previously, if a received response contained HTTP 100 Continue, you did not see any response headers in the Response column in Traffic Monitor. Now, API Gateway Manager skips all HTTP 100 Continue responses, and you can see the final response headers in Traffic Monitor.
RDAPI-9017 00884757

Issue: Unable to configure SSL settings for outbound connections.

Resolution: Previously, you could not configure SSL/TLS protocols for outbound connections in the Connect To URL filter in API Gateway. Now, you can configure default SSL/TLS protocols for outbound connections in the Connect To URL filter by adding the following code to the system/conf/ssloptions.xml settings file:

<ConfigurationFragment> 
    <SystemSettings> 
        <!-- SSL options for outgoing connections --> 
... 
        <!-- Do not use the TLSv1.1 protocol --> 
        <!-- <attribute key="ssloptions">notlsv1_1</attribute> --> 

        <!-- Do not use the TLSv1.2 protocol --> 
        <!-- <attribute key="ssloptions">notlsv1_2</attribute> --> 
    </SystemSettings> 
</ConfigurationFragment>

Known issues

This service pack has no known issues.

Install the service pack

Prerequisites

This service pack has the following prerequisites in addition to the prerequisites specified for the main product release:

  1. Shut down any Node Manager or API Gateway instances on your existing installation.
  2. Back up your existing installation. For details on backing up, see the API Gateway Administrator Guide.
  3. Remove any old third-party libraries. To do this, delete the INSTALL_DIR/system/lib/modules directory.
  4. If you have an existing Cassandra installation, ensure JAVA_HOME is set correctly in cassandra.in.sh and cassandra.in.bat to ensure Cassandra tools are launched successfully.

FIPS mode only

If FIPS mode is enabled, you must perform the following steps to install the service pack:

  1. Run togglefips --disable to turn FIPS mode off.
  2. Start the Node Manager to move the JARs.
  3. Stop the Node Manager.
  4. Install the API Gateway service pack.
  5. Start the Node Manager.
  6. Stop the Node Manager.
  7. Run togglefips --enable to turn FIPS on again.
  8. Start the Node Manager.

Installation

This section describes how to install the service pack on an existing installation of API Gateway.

Note

  • To install a new API Gateway installation from scratch without an existing installation, see the API Gateway Installation Guide.
  • To upgrade from an earlier version of API Gateway to 7.5.2, see the API Gateway Upgrade Guide.

Install the API Gateway Core Server service pack

To install the service pack on your existing API Gateway 7.5.2 Core Server installation, perform the following
steps:

  1. Ensure that your existing API Gateway instance and Node Manager have been stopped. For more details, see the API Gateway Administrator Guide.
  2. Remove any previous patches from your INSTALL_DIR/ext/lib directory (or the ext/lib directory in an API Gateway instance). These patches have already been included in this service pack. You do not need to copy patches from a previous version.

  3. Unzip and extract API Gateway 7.5.2 SP 4 Core over the apigateway directory in your existing installation directory. For example:
    tar -xzvf APIGateway_7.5.2_SP4_Core_linux-x86-64_BNYYYYMMDDn.tar.gz -C /opt/Axway-7.5.2/apigateway/

  4. Run the following script:
    Linux: INSTALL_DIR/apigateway/apigw_sp_post_install.sh
    Windows: INSTALL_DIR\apigateway\apigw_sp_post_install.bat

    API Gateway Appliance only
    Perform the following additional steps on the appliance before starting the Node Manager or API Gateway:
  5. Run the following command:
    # [ -f /etc/vordel/ssl-engines.xml ] && mv /etc/vordel/ssl-engines.xml /etc/vordel/ssl-engines.xml.1
  6. Run the following:
    # chown -R admin:admin /opt/gateway/
    # grep "java.library.path" /opt/gateway/system/conf/jvm.xml || sed -i.bak -e '/<JVMSettings/a\\n <!-- Set to allow correct library load after setting CAP_NET_BIND_SERVICE on vshell -->\n <VMArg name="-Djava.library.path=$VDISTDIR/$DISTRIBUTION/jre/lib/amd64/server:$VDISTDIR/$DISTRIBUTION/jre/lib/amd64:$VDISTDIR/$DISTRIBUTION/lib/engines:$VDISTDIR/ext/$DISTRIBUTION/lib:$VDISTDIR/ext/lib:$VDISTDIR/$DISTRIBUTION/jre/lib:system/lib:$VDISTDIR/$DISTRIBUTION/lib"/>' /opt/gateway/system/conf/jvm.xml
    # setcap 'cap_net_bind_service=+ep cap_sys_rawio=+ep' /opt/gateway/platform/bin/vshell
    # ldconfig

Note

  • If you have installed a licensed version of API Gateway 7.5.2, you do not require a new license to install service packs.
  • Unzip and extract the service pack as the same user who owns the API Gateway binaries. You can use the ls -l INSTALL_DIR/apigateway/posix/bin command to view the owner of the binaries.
  • If you have installed an existing version of API Gateway Analytics, you must apply a separate service pack for that component (see the next section).
  • If you have installed an existing version of API Manager, you must apply a separate service pack for that component (see the Readme for Axway API Manager 7.5.2 SP 4).

Install the API Gateway Analytics service pack

To install the service pack on your existing API Gateway Analytics 7.5.2 installation, perform the following
steps:

  1. Ensure that your existing API Gateway Analytics instance and Node Manager have been stopped. For more details, see the API Gateway Administrator Guide.
  2. Remove any previous patches from your INSTALL_DIR/ext/lib directory (or the ext/lib directory in an API Gateway Analytics instance). These patches have already been included in this service pack. You do not need to copy patches from a previous version.
  3. Unzip and extract API Gateway 7.5.2 SP 4 Analytics over the analytics directory within your existing API Gateway 7.5.2 installation directory. For example:
    tar -xzvf APIGateway_7.5.2_SP4_Analytics_linux-x86-64_BNYYYYMMDDn.tar.gz -C /opt/Axway-7.5.2/analytics/
  4. Run the following script:
    Linux: INSTALL_DIR/analytics/apigw_analytics_sp_post_install.sh
    Windows: INSTALL_DIR\analytics\apigw_analytics_sp_post_install.bat

Note

  • Unzip and extract the service pack as the same user who owns the API Gateway Analytics binaries. You can use the ls -l INSTALL_DIR/analytics/posix/bin command to view the owner of the binaries.
  • You must also install a service pack for your existing 7.5.2 Core Server.

Install the Policy Studio service pack

To install the service pack on your existing Policy Studio installation, perform the following steps:

  1. Shut down Policy Studio.
  2. Back up your existing INSTALL_DIR/policystudio directory.
  3. Unzip and extract API Gateway 7.5.2 SP 4 Policy Studio over the policystudio directory within your existing API Gateway 7.5.2 installation directory. For example:
    tar -xzvf APIGateway_7.5.2_SP4_PolicyStudio_linux-x86-64_BNYYYYMMDDn.tar.gz -C /opt/Axway-7.5.2/policystudio/

Note

  • The first time you start Policy Studio, you must use policystudio -clean.

Install the Configuration Studio service pack

To install the service pack on your existing Configuration Studio installation, perform the following steps:

  1. Shut down Configuration Studio.
  2. Back up your existing INSTALL_DIR/configurationstudio directory.
  3. Unzip and extract API Gateway 7.5.2 SP 4 Configuration Studio over the configurationstudio directory within your existing API Gateway 7.5.2 installation directory. For example:
    tar -xzvf APIGateway_7.5.2_SP4_ConfigurationStudio_linux-x86-64_BNYYYYMMDDn.tar.gz -C /opt/Axway-7.5.2/configurationstudio/

Note

  • The first time you start Configuration Studio, you must use configurationstudio -clean.

After installation

Note

To allow an unprivileged user to run the API Gateway on a Linux system, perform the following steps:

  1. Add the following line to the INSTALL_DIR/system/conf/jvm.xml file:
    <VMArg name="-Djava.library.path=$VDISTDIR/$DISTRIBUTION/jre/lib/amd64/server:$VDISTDIR/$DISTRIBUTION/jre/lib/amd64:$VDISTDIR/$DISTRIBUTION/lib/engines:$VDISTDIR/ext/$DISTRIBUTION/lib:$VDISTDIR/ext/lib:$VDISTDIR/$DISTRIBUTION/jre/lib:system/lib:$VDISTDIR/$DISTRIBUTION/lib"/>
  2. Run the command setcap 'cap_net_bind_service=+ep' INSTALL_DIR/platform/bin/vshell to allow the API Gateway to listen on privileged ports.

Documentation

Go to the Documentation portal at http://docs.axway.com to find all documentation for this product version.

The following reference documents are available on the Documentation portal at http://docs.axway.com:

  • Axway Supported Platforms
  • Axway Interoperability Matrix

Support services

The Axway Global Support team provides worldwide 24 x 7 support for customers with active support agreements.

Email support@axway.com or visit Axway Support at https://support.axway.com.


Copyright © 2017 Axway. All rights reserved.