Axway API Gateway 7.4.1 SP 5 Readme
Document version: 24 July 2017
Readme for 7.4.1 SP 5
This Readme applies to Axway API Gateway 7.4.1 SP 5, 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.4.1_SP5_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 identifier | Description |
---|---|---|---|
RDAPI‑8787 | 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. |
Other fixed issues
Internal ID | Case ID | Description |
---|---|---|
RDAPI-6621 | 00867003 | Issue: Limit when reading objects from hardware security module (HSM).
Resolution: Previously, HSM PKCS#11 Java interface implementation in API Gateway was limited to read only 10 objects from HSM. Now, the PKCS#11 Java interface implementation in API Gateway can read all objects in the HSM. |
RDAPI-7037 | 00862631, 00854315 | Issue: Issues with nested relative paths.
Resolution: Previously, API Gateway generated a NullPointerException , a failed transaction, and incomplete Traffic Monitor information for nested relative path requests. Now, API Gateway completes the requests successfully, generates a successful transaction, and records all paths in Traffic Monitor. |
RDAPI-7166 | 00874107 | Issue: HTTP status code missing from access logs.
Resolution: Previously, if you enabled the transaction access logging for a policy where you had set the status code option, the status code was not shown in the access log file. Now, the status code is correctly shown in the access log file. |
RDAPI-8431 | 00876470 | Issue: Client certificate fails when CA certificates have the same name.
Resolution: Previously, you could not use several CA certificates with the same Subject Distinguished Name (DName) but different Subject Key Identifiers. API Gateway was unable to build the correct certificate chain, and mutual authentication failed. Now, API Gateway can verify certificates against CA certificates with the same Subject DName but different the Subject Key Identifiers, and mutual authentication succeeds. |
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:
- Shut down any Node Manager or API Gateway instances on your existing installation.
- Back up your existing installation. For details on backing up, see the API Gateway Administrator Guide.
- Remove any old third-party libraries. To do this, delete the
INSTALL_DIR/system/lib/modules
directory. - If you have an existing Cassandra installation, ensure
JAVA_HOME
is set correctly incassandra.in.sh
andcassandra.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:
- Run
togglefips --disable
to turn FIPS mode off. - Start the Node Manager to move the JARs.
- Stop the Node Manager.
- Install the API Gateway service pack.
- Start the Node Manager.
- Stop the Node Manager.
- Run
togglefips --enable
to turn FIPS on again. - 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.4.1, 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.4.1 Core Server installation, perform the following
steps:
- Ensure that your existing API Gateway instance and Node Manager have been stopped. For more details, see the API Gateway Administrator Guide.
-
Remove any previous patches from your
INSTALL_DIR/ext/lib
directory (or theext/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. -
Unzip and extract API Gateway 7.4.1 SP 5 Core over the
apigateway
directory in your existing installation directory. For example:tar -xzvf APIGateway_7.4.1_SP5_Core_linux-x86-64_BNYYYYMMDDn.tar.gz -C /opt/Axway-7.4.1/apigateway/
-
API Gateway Appliance only
Perform the following additional steps on the appliance before starting the Node Manager or API Gateway: - Run the following command:
# [ -f /etc/vordel/ssl-engines.xml ] && mv /etc/vordel/ssl-engines.xml /etc/vordel/ssl-engines.xml.1
- 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.4.1, 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.4.1 SP 5).
Install the API Gateway Analytics service pack
To install the service pack on your existing API Gateway Analytics 7.4.1 installation, perform the following
steps:
- Ensure that your existing API Gateway Analytics instance and Node Manager have been stopped. For more details, see the API Gateway Administrator Guide.
- Remove any previous patches from your
INSTALL_DIR/ext/lib
directory (or theext/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. - Unzip and extract API Gateway 7.4.1 SP 5 Analytics over the
analytics
directory within your existing API Gateway 7.4.1 installation directory. For example:tar -xzvf APIGateway_7.4.1_SP5_Analytics_linux-x86-64_BNYYYYMMDDn.tar.gz -C /opt/Axway-7.4.1/analytics/
- 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.4.1 Core Server.
Install the Policy Studio service pack
To install the service pack on your existing Policy Studio installation, perform the following steps:
- Shut down Policy Studio.
- Back up your existing
INSTALL_DIR/policystudio
directory. - Unzip and extract API Gateway 7.4.1 SP 5 Policy Studio over the
policystudio
directory within your existing API Gateway 7.4.1 installation directory. For example:tar -xzvf APIGateway_7.4.1_SP5_PolicyStudio_linux-x86-64_BNYYYYMMDDn.tar.gz -C /opt/Axway-7.4.1/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:
- Shut down Configuration Studio.
- Back up your existing
INSTALL_DIR/configurationstudio
directory. - Unzip and extract API Gateway 7.4.1 SP 5 Configuration Studio over the
configurationstudio
directory within your existing API Gateway 7.4.1 installation directory. For example:tar -xzvf APIGateway_7.4.1_SP5_ConfigurationStudio_linux-x86-64_BNYYYYMMDDn.tar.gz -C /opt/Axway-7.4.1/configurationstudio/
Note
- The first time you start Configuration Studio, you must use
configurationstudio -clean
.
After installation
Note
- On the API Gateway Appliance, you can skip the following steps if you already ran the code in steps 5 and 6 in Install the API Gateway Core Server service pack.
To allow an unprivileged user to run the API Gateway on a Linux system, perform the following steps:
- 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"/>
- 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.