Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace SSLConfiguration

A listener's SSL handling configuration.

To use SSL, a listener must be associated with a Certificate.

*Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Properties

Optional certificateIds

certificateIds: Array<string>

Ids for OCI certificates service certificates. Currently only a single Id may be passed.

Example: {@code [ocid1.certificate.oc1.us-ashburn-1.amaaaaaaav3bgsaa5o2q7rh5nfmkkukfkogasqhk6af2opufhjlqg7m6jqzq]}

Optional certificateName

certificateName: undefined | string

A friendly name for the certificate bundle. It must be unique and it cannot be changed. Valid certificate bundle names include only alphanumeric characters, dashes, and underscores. Certificate bundle names cannot contain spaces. Avoid entering confidential information.

Example: {@code example_certificate_bundle}

Optional cipherSuiteName

cipherSuiteName: undefined | string

The name of the cipher suite to use for HTTPS or SSL connections.

If this field is not specified, the default is {@code oci-default-ssl-cipher-suite-v1}.

*Notes:**

You must ensure compatibility between the specified SSL protocols and the ciphers configured in the cipher suite. Clients cannot perform an SSL handshake if there is an incompatible configuration. * You must ensure compatibility between the ciphers configured in the cipher suite and the configured certificates. For example, RSA-based ciphers require RSA certificates and ECDSA-based ciphers require ECDSA certificates. * If the cipher configuration is not modified after load balancer creation, the {@code GET} operation returns {@code oci-default-ssl-cipher-suite-v1} as the value of this field in the SSL configuration for existing listeners that predate this feature. * If the cipher configuration was modified using Oracle operations after load balancer creation, the {@code GET} operation returns {@code oci-customized-ssl-cipher-suite} as the value of this field in the SSL configuration for existing listeners that predate this feature. * The {@code GET} operation returns {@code oci-wider-compatible-ssl-cipher-suite-v1} as the value of this field in the SSL configuration for existing backend sets that predate this feature. * If the {@code GET} operation on a listener returns {@code oci-customized-ssl-cipher-suite} as the value of this field, you must specify an appropriate predefined or custom cipher suite name when updating the resource. * The {@code oci-customized-ssl-cipher-suite} Oracle reserved cipher suite name is not accepted as valid input for this field.

example: {@code example_cipher_suite}

Optional protocols

protocols: Array<string>

A list of SSL protocols the load balancer must support for HTTPS or SSL connections.

The load balancer uses SSL protocols to establish a secure connection between a client and a server. A secure connection ensures that all data passed between the client and the server is private.

The Load Balancing service supports the following protocols:

TLSv1 * TLSv1.1 * TLSv1.2

If this field is not specified, TLSv1.2 is the default.

*Warning:** All SSL listeners created on a given port must use the same set of SSL protocols.

*Notes:**

The handshake to establish an SSL connection fails if the client supports none of the specified protocols. * You must ensure compatibility between the specified SSL protocols and the ciphers configured in the cipher suite. * For all existing load balancer listeners and backend sets that predate this feature, the {@code GET} operation displays a list of SSL protocols currently used by those resources.

example: {@code [\"TLSv1.1\", \"TLSv1.2\"]}

Optional serverOrderPreference

serverOrderPreference: ServerOrderPreference

When this attribute is set to ENABLED, the system gives preference to the server ciphers over the client ciphers.

*Note:** This configuration is applicable only when the load balancer is acting as an SSL/HTTPS server. This field is ignored when the {@code SSLConfiguration} object is associated with a backend set.

Optional trustedCertificateAuthorityIds

trustedCertificateAuthorityIds: Array<string>

Ids for OCI certificates service CA or CA bundles for the load balancer to trust.

Example: {@code [ocid1.cabundle.oc1.us-ashburn-1.amaaaaaaav3bgsaagl4zzyqdop5i2vuwoqewdvauuw34llqa74otq2jdsfyq]}

verifyDepth

verifyDepth: number

The maximum depth for peer certificate chain verification.

Example: {@code 3} Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

verifyPeerCertificate

verifyPeerCertificate: boolean

Whether the load balancer listener should verify peer certificates.

Example: {@code true}

Functions

getDeserializedJsonObj

getJsonObj