API Gateway 10.5 | Using API Gateway | API Gateway Administration | Security Configuration | Ports | Adding an HTTPS Port
 
Adding an HTTPS Port
The HTTPS port enables API Gateway to authenticate the client and server securely and encrypt the data exchanged. By default, the HTTPS listener uses the certificates for the default SSL key. In addition, you can configure the type of client authentication that you want the server to perform. Client authentication allows you to verify the identity of the client.
*To add an HTTPS port
1. Expand the menu options icon menu option, in the title bar, and select Administration.
2. Select Security > Ports.
The ports page lists all the ports configured with API Gateway, if any.
3. Click Add Ports.
4. Select the type of port as HTTPS and click Add.
5. Provide the following information:
Field
Description
HTTPS listener configuration
Port
Specify the number you want to use for the port.
Select a number that is not already in use on this host machine.
Alias
Specifies an alias for the port that is unique for this API Gateway.
An alias must be between 1 and 255 characters in length and include one or more of the following: letters (a -z, A-Z), numbers (0-9), underscore (_), period (.), and hyphen (-).
Description (optional)
Provide a description of the port.
Bind address (optional)
Specifies the IP address to which to bind this port.
Specify a bind address if your machine has multiple IP addresses and you want the port to use this specific address. If you do not specify a bind address, API Gateway picks one for you.
Backlog
Specifies the number of requests that can remain in the queue for an enabled port before API Gateway begins rejecting requests.
The default is 200. The maximum value is 65535.
Keep alive timeout
Specifies when to close the connection if the server has not received a request from the client within this timeout value (in milliseconds) or when to close the connection if the client has explicitly placed a close request with the server.
Private threadpool configuration. Specifies whether to create a private thread pool for this port or use the common thread pool.
Enable
Select to enable the private threadpool configuration for this port.
Threadpool min
Specifies the minimum number of threads for this private threadpool. The default is 1.
Threadpool max
Specifies the maximum number of threads for this private thread pool. The default is 5.
Thread priority
Specifies the Java thread priority. The default is 5.
Security configuration
Client authentication
Specifies the type of client authentication you want API Gateway to perform for requests that arrive on this HTTPS port.
Select one of the following:
*Username/Password. API Gateway does not request client certificates. The server looks for user and password information in the header of requests coming from an external client.
*Digest. API Gateway uses password digest to authenticate all requests. If the client does not provide the authentication information, API Gateway returns an HTTP WWW-Authenticate header with digest scheme to the client requesting for authentication information. If the client provides the required authentication information, API Gateway verifies and validates the request.
*Request Kerberos Ticket. API Gateway looks for a Kerberos ticket in the HTTPS Authorization header using the Negotiate authentication scheme. If it does not find the ticket, API Gateway uses user name and password for basic authentication. If the client does not provide any authentication information, API Gateway returns an HTTP WWW-Authenticate header with negotiate scheme to the client requesting for authentication information. If the client provides the required authentication information, API Gateway verifies and validates the request.
*Require Kerberos Ticket. API Gateway looks for a Kerberos ticket in the HTTPS Authorization header using the Negotiate authentication scheme. If it does not find the ticket, API Gateway fails the authentication. If the client does not provide any authentication information, API Gateway returns an HTTP WWW-Authenticate header with negotiate scheme to the client requesting for authentication information. If the client provides the required authentication information, API Gateway verifies and validates the request.
You have to enable Kerberos by providing the following Kerberos properties with details that are used for handling service requests that come with a Kerberos ticket:
*JAAS context. Specify the custom JAAS context used for Kerberos authentication.
*Principal. Specify the name of the principal to use for Kerberos authentication.
*Principal password. Specify the password for the principal to use to authenticate the principal to the KDC.
*Retype principal password. Retype the principal password.
*Service principal name. Specify the name of the principal used with the service that the Kerberos client wants to access.
Note:
API Gateway supports the username format for Service Principal Names (SPNs). This format represents the principal name as a named user defined in LDAP used for authentication to the KDC.
*Request Client Certificate. API Gateway requests client certificates for all requests. If the client does not provide a certificate, the server prompts the client for a userid and password. The server checks whether the certificate exactly matches a client certificate on file and is signed by a trusted authority. If so, the client is logged in as the user to which the certificate is mapped in API Gateway. If not, the client request fails, unless central user management is configured.
*Require Client Certificate. API Gateway requires client certificates for all requests. The server behaves as described for Request Client Certificates, except that the client must always provide a certificate.
*Use Identity Provider. API Gateway uses an OpenID Provider to authenticate requests. API Gateway redirects all requests sent to this port to the OpenID Provider specified in Identity Provider.
Listener specific credentials
Keystore alias
Specifies a user-specified, text identifier for an API Gateway keystore.
The alias points to a repository of private keys and their associated certificates. Although each listener points to one keystore, there can be multiple keys and their certificates in the same keystore, and more than one listener can use the same keystore alias.
Key alias (signing)
Specifies the private key of keystore.
Truststore alias
Specifies the public certificates of truststore.
The alias points to a repository of public certificates.
6. Click Add.
The port is created and is listed in the ports table.
Important:
The default access mode of the port is set to Allow by default. This implies that the port allows connections to all ESB services and folders. Users must note that this setting allows access to all enterprise assets hosted in internal Integration Server. There is a potential security risk for the IS assets that are secured by Anonymous Access Control Lists (ACL) or if the installation is exposed to the public internet. Hence, you can set the access mode of the port to Deny by default before enabling it. When you change the access mode, you add the required services and folders to the Allow list. For more information, see Configuring Access Mode for a Port.
Also, the global IP access mode will be applied to the newly created HTTPS ports. You can modify the IP access mode as per your requirement. For information on modifying IP access mode of ports, see Configuring IP Access Mode for a Port.
7. Click the enable port icon in the Enabled column next to the port to enable the port.
The port is enabled and a success message appears.