software.amazon.awssdk.crt.io

Enum TlsCipherPreference

java.lang.Object

java.lang.Enum<TlsCipherPreference>

software.amazon.awssdk.crt.io.TlsCipherPreference

All Implemented Interfaces:

Serializable, Comparable<TlsCipherPreference>

public enum TlsCipherPreference
extends Enum<TlsCipherPreference>

A TlsCipherPreference represents a hardcoded ordered list of TLS Ciphers to use when negotiating a TLS Connection. At present, the ability to configure arbitrary orderings of TLS Ciphers is not allowed, and only a curated list of vetted TlsCipherPreference's are exposed.

Enum Constant Summary

Enum Constants

Enum Constant and Description
TLS_CIPHER_KMS_PQ_TLSv1_0_2019_06 This TlsCipherPreference contains BIKE and SIKE Draft Hybrid TLS Ciphers at the top of the preference list.
TLS_CIPHER_SYSTEM_DEFAULT Use whatever the System Default Preference is.

Method Summary

Modifier and Type	Method and Description
boolean	isSupported() Not all Cipher Preferences are supported on all Platforms due to differences in the underlying TLS Libraries.
static TlsCipherPreference	valueOf(String name) Returns the enum constant of this type with the specified name.
static TlsCipherPreference[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

TLS_CIPHER_SYSTEM_DEFAULT

public static final TlsCipherPreference TLS_CIPHER_SYSTEM_DEFAULT

Use whatever the System Default Preference is. This is usually the best option, as it will be automatically updated as the underlying OS or platform changes, and will always be supported on all Platforms.

TLS_CIPHER_KMS_PQ_TLSv1_0_2019_06

public static final TlsCipherPreference TLS_CIPHER_KMS_PQ_TLSv1_0_2019_06

This TlsCipherPreference contains BIKE and SIKE Draft Hybrid TLS Ciphers at the top of the preference list. - For more info see: https://tools.ietf.org/html/draft-campagna-tls-bike-sike-hybrid These Hybrid TLS ciphers perform two Key Exchanges (1 ECDHE + 1 Post-Quantum) during the TLS Handshake in order to combine the security of Classical ECDHE Key Exchange with the conjectured quantum-resistance of newly proposed key exchanges. The algorithms these new Post-Quantum ciphers are based on have been submitted to NIST's Post-Quantum Crypto Standardization Process, and are still under review. While these Post Quantum Hybrid TLS Ciphers are the most preferred ciphers in the preference list, classical ciphers are still present and can be negotiated if the TLS peer does not support these Hybrid TLS Ciphers. This Cipher Preference may stop being supported at any time.

Method Detail

values

public static TlsCipherPreference[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (TlsCipherPreference c : TlsCipherPreference.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static TlsCipherPreference valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

isSupported

public boolean isSupported()

Not all Cipher Preferences are supported on all Platforms due to differences in the underlying TLS Libraries.

Returns:

True if this TlsCipherPreference is currently supported on the current platform.