Class UpstreamTlsContext
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.transport_sockets.tls.v3.UpstreamTlsContext
- All Implemented Interfaces:
com.google.protobuf.Message,com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,UpstreamTlsContextOrBuilder,Serializable
public final class UpstreamTlsContext
extends com.google.protobuf.GeneratedMessageV3
implements UpstreamTlsContextOrBuilder
[#next-free-field: 8]Protobuf type
envoy.extensions.transport_sockets.tls.v3.UpstreamTlsContext- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class[#next-free-field: 8]Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleanbooleanIf true, server-initiated TLS renegotiation will be allowed. .. attention:: TLS renegotiation is considered insecure and shouldn't be used unless absolutely necessary.booleanIf true, replaces the SNI for the connection with the hostname of the upstream host, if the hostname is known due to either a DNS cluster type or the :ref:`hostname <envoy_v3_api_field_config.endpoint.v3.Endpoint.hostname>` is set on the host.booleanIf true, replaces any Subject Alternative Name (SAN) validations with a validation for a DNS SAN matching the SNI value sent.Common TLS context settings. .. attention:: Server certificate verification is not enabled by default.Common TLS context settings. .. attention:: Server certificate verification is not enabled by default.static UpstreamTlsContextstatic final com.google.protobuf.Descriptors.Descriptorcom.google.protobuf.BoolValueControls enforcement of the ``keyUsage`` extension in peer certificates.com.google.protobuf.BoolValueOrBuilderControls enforcement of the ``keyUsage`` extension in peer certificates.com.google.protobuf.UInt32ValueMaximum number of session keys (Pre-Shared Keys for TLSv1.3+, Session IDs and Session Tickets for TLSv1.2 and older) to be stored for session resumption.com.google.protobuf.UInt32ValueOrBuilderMaximum number of session keys (Pre-Shared Keys for TLSv1.3+, Session IDs and Session Tickets for TLSv1.2 and older) to be stored for session resumption.com.google.protobuf.Parser<UpstreamTlsContext>intgetSni()SNI string to use when creating TLS backend connections.com.google.protobuf.ByteStringSNI string to use when creating TLS backend connections.booleanCommon TLS context settings. .. attention:: Server certificate verification is not enabled by default.booleanControls enforcement of the ``keyUsage`` extension in peer certificates.inthashCode()booleanMaximum number of session keys (Pre-Shared Keys for TLSv1.3+, Session IDs and Session Tickets for TLSv1.2 and older) to be stored for session resumption.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTablefinal booleanstatic UpstreamTlsContext.Builderstatic UpstreamTlsContext.BuildernewBuilder(UpstreamTlsContext prototype) protected UpstreamTlsContext.BuildernewBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) protected ObjectnewInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) static UpstreamTlsContextparseDelimitedFrom(InputStream input) static UpstreamTlsContextparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static UpstreamTlsContextparseFrom(byte[] data) static UpstreamTlsContextparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static UpstreamTlsContextparseFrom(com.google.protobuf.ByteString data) static UpstreamTlsContextparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static UpstreamTlsContextparseFrom(com.google.protobuf.CodedInputStream input) static UpstreamTlsContextparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static UpstreamTlsContextparseFrom(InputStream input) static UpstreamTlsContextparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static UpstreamTlsContextparseFrom(ByteBuffer data) static UpstreamTlsContextparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<UpstreamTlsContext>parser()voidwriteTo(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
COMMON_TLS_CONTEXT_FIELD_NUMBER
public static final int COMMON_TLS_CONTEXT_FIELD_NUMBER- See Also:
-
SNI_FIELD_NUMBER
public static final int SNI_FIELD_NUMBER- See Also:
-
AUTO_HOST_SNI_FIELD_NUMBER
public static final int AUTO_HOST_SNI_FIELD_NUMBER- See Also:
-
AUTO_SNI_SAN_VALIDATION_FIELD_NUMBER
public static final int AUTO_SNI_SAN_VALIDATION_FIELD_NUMBER- See Also:
-
ALLOW_RENEGOTIATION_FIELD_NUMBER
public static final int ALLOW_RENEGOTIATION_FIELD_NUMBER- See Also:
-
MAX_SESSION_KEYS_FIELD_NUMBER
public static final int MAX_SESSION_KEYS_FIELD_NUMBER- See Also:
-
ENFORCE_RSA_KEY_USAGE_FIELD_NUMBER
public static final int ENFORCE_RSA_KEY_USAGE_FIELD_NUMBER- See Also:
-
-
Method Details
-
newInstance
- Overrides:
newInstancein classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3
-
hasCommonTlsContext
public boolean hasCommonTlsContext()Common TLS context settings. .. attention:: Server certificate verification is not enabled by default. To enable verification, configure :ref:`trusted_ca<envoy_v3_api_field_extensions.transport_sockets.tls.v3.CertificateValidationContext.trusted_ca>`.
.envoy.extensions.transport_sockets.tls.v3.CommonTlsContext common_tls_context = 1;- Specified by:
hasCommonTlsContextin interfaceUpstreamTlsContextOrBuilder- Returns:
- Whether the commonTlsContext field is set.
-
getCommonTlsContext
Common TLS context settings. .. attention:: Server certificate verification is not enabled by default. To enable verification, configure :ref:`trusted_ca<envoy_v3_api_field_extensions.transport_sockets.tls.v3.CertificateValidationContext.trusted_ca>`.
.envoy.extensions.transport_sockets.tls.v3.CommonTlsContext common_tls_context = 1;- Specified by:
getCommonTlsContextin interfaceUpstreamTlsContextOrBuilder- Returns:
- The commonTlsContext.
-
getCommonTlsContextOrBuilder
Common TLS context settings. .. attention:: Server certificate verification is not enabled by default. To enable verification, configure :ref:`trusted_ca<envoy_v3_api_field_extensions.transport_sockets.tls.v3.CertificateValidationContext.trusted_ca>`.
.envoy.extensions.transport_sockets.tls.v3.CommonTlsContext common_tls_context = 1;- Specified by:
getCommonTlsContextOrBuilderin interfaceUpstreamTlsContextOrBuilder
-
getSni
SNI string to use when creating TLS backend connections.
string sni = 2 [(.validate.rules) = { ... }- Specified by:
getSniin interfaceUpstreamTlsContextOrBuilder- Returns:
- The sni.
-
getSniBytes
public com.google.protobuf.ByteString getSniBytes()SNI string to use when creating TLS backend connections.
string sni = 2 [(.validate.rules) = { ... }- Specified by:
getSniBytesin interfaceUpstreamTlsContextOrBuilder- Returns:
- The bytes for sni.
-
getAutoHostSni
public boolean getAutoHostSni()If true, replaces the SNI for the connection with the hostname of the upstream host, if the hostname is known due to either a DNS cluster type or the :ref:`hostname <envoy_v3_api_field_config.endpoint.v3.Endpoint.hostname>` is set on the host. See :ref:`SNI configuration <start_quick_start_securing_sni_client>` for details on how this interacts with other validation options.
bool auto_host_sni = 6;- Specified by:
getAutoHostSniin interfaceUpstreamTlsContextOrBuilder- Returns:
- The autoHostSni.
-
getAutoSniSanValidation
public boolean getAutoSniSanValidation()If true, replaces any Subject Alternative Name (SAN) validations with a validation for a DNS SAN matching the SNI value sent. The validation uses the actual requested SNI, regardless of how the SNI is configured. For common cases where an SNI value is present and the server certificate should include a corresponding SAN, this option ensures the SAN is properly validated. See the :ref:`validation configuration <start_quick_start_securing_validation>` for how this interacts with other validation options.
bool auto_sni_san_validation = 7;- Specified by:
getAutoSniSanValidationin interfaceUpstreamTlsContextOrBuilder- Returns:
- The autoSniSanValidation.
-
getAllowRenegotiation
public boolean getAllowRenegotiation()If true, server-initiated TLS renegotiation will be allowed. .. attention:: TLS renegotiation is considered insecure and shouldn't be used unless absolutely necessary.
bool allow_renegotiation = 3;- Specified by:
getAllowRenegotiationin interfaceUpstreamTlsContextOrBuilder- Returns:
- The allowRenegotiation.
-
hasMaxSessionKeys
public boolean hasMaxSessionKeys()Maximum number of session keys (Pre-Shared Keys for TLSv1.3+, Session IDs and Session Tickets for TLSv1.2 and older) to be stored for session resumption. Defaults to 1, setting this to 0 disables session resumption.
.google.protobuf.UInt32Value max_session_keys = 4;- Specified by:
hasMaxSessionKeysin interfaceUpstreamTlsContextOrBuilder- Returns:
- Whether the maxSessionKeys field is set.
-
getMaxSessionKeys
public com.google.protobuf.UInt32Value getMaxSessionKeys()Maximum number of session keys (Pre-Shared Keys for TLSv1.3+, Session IDs and Session Tickets for TLSv1.2 and older) to be stored for session resumption. Defaults to 1, setting this to 0 disables session resumption.
.google.protobuf.UInt32Value max_session_keys = 4;- Specified by:
getMaxSessionKeysin interfaceUpstreamTlsContextOrBuilder- Returns:
- The maxSessionKeys.
-
getMaxSessionKeysOrBuilder
public com.google.protobuf.UInt32ValueOrBuilder getMaxSessionKeysOrBuilder()Maximum number of session keys (Pre-Shared Keys for TLSv1.3+, Session IDs and Session Tickets for TLSv1.2 and older) to be stored for session resumption. Defaults to 1, setting this to 0 disables session resumption.
.google.protobuf.UInt32Value max_session_keys = 4;- Specified by:
getMaxSessionKeysOrBuilderin interfaceUpstreamTlsContextOrBuilder
-
hasEnforceRsaKeyUsage
public boolean hasEnforceRsaKeyUsage()Controls enforcement of the ``keyUsage`` extension in peer certificates. If set to ``true``, the handshake will fail if the ``keyUsage`` is incompatible with TLS usage. .. note:: The default value is ``false`` (i.e., enforcement off). It is expected to change to ``true`` in a future release. The ``ssl.was_key_usage_invalid`` in :ref:`listener metrics <config_listener_stats>` metric will be incremented for configurations that would fail if this option were enabled.
.google.protobuf.BoolValue enforce_rsa_key_usage = 5;- Specified by:
hasEnforceRsaKeyUsagein interfaceUpstreamTlsContextOrBuilder- Returns:
- Whether the enforceRsaKeyUsage field is set.
-
getEnforceRsaKeyUsage
public com.google.protobuf.BoolValue getEnforceRsaKeyUsage()Controls enforcement of the ``keyUsage`` extension in peer certificates. If set to ``true``, the handshake will fail if the ``keyUsage`` is incompatible with TLS usage. .. note:: The default value is ``false`` (i.e., enforcement off). It is expected to change to ``true`` in a future release. The ``ssl.was_key_usage_invalid`` in :ref:`listener metrics <config_listener_stats>` metric will be incremented for configurations that would fail if this option were enabled.
.google.protobuf.BoolValue enforce_rsa_key_usage = 5;- Specified by:
getEnforceRsaKeyUsagein interfaceUpstreamTlsContextOrBuilder- Returns:
- The enforceRsaKeyUsage.
-
getEnforceRsaKeyUsageOrBuilder
public com.google.protobuf.BoolValueOrBuilder getEnforceRsaKeyUsageOrBuilder()Controls enforcement of the ``keyUsage`` extension in peer certificates. If set to ``true``, the handshake will fail if the ``keyUsage`` is incompatible with TLS usage. .. note:: The default value is ``false`` (i.e., enforcement off). It is expected to change to ``true`` in a future release. The ``ssl.was_key_usage_invalid`` in :ref:`listener metrics <config_listener_stats>` metric will be incremented for configurations that would fail if this option were enabled.
.google.protobuf.BoolValue enforce_rsa_key_usage = 5;- Specified by:
getEnforceRsaKeyUsageOrBuilderin interfaceUpstreamTlsContextOrBuilder
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessageV3- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessageV3
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.google.protobuf.AbstractMessage
-
parseFrom
public static UpstreamTlsContext parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static UpstreamTlsContext parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static UpstreamTlsContext parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static UpstreamTlsContext parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static UpstreamTlsContext parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static UpstreamTlsContext parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static UpstreamTlsContext parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static UpstreamTlsContext parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
public static UpstreamTlsContext parseFrom(com.google.protobuf.CodedInputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static UpstreamTlsContext parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected UpstreamTlsContext.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) - Specified by:
newBuilderForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-