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 Classes
    Modifier and Type
    Class
    Description
    static 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

    Fields
    Modifier and Type
    Field
    Description
    static final int
     
    static final int
     
    static final int
     
    static final int
     
    static final int
     
    static final int
     
    static final int
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
     
    boolean
    If true, server-initiated TLS renegotiation will be allowed. .. attention:: TLS renegotiation is considered insecure and shouldn't be used unless absolutely necessary.
    boolean
    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.
    boolean
    If 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 final com.google.protobuf.Descriptors.Descriptor
     
    com.google.protobuf.BoolValue
    Controls enforcement of the ``keyUsage`` extension in peer certificates.
    com.google.protobuf.BoolValueOrBuilder
    Controls enforcement of the ``keyUsage`` extension in peer certificates.
    com.google.protobuf.UInt32Value
    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.
    com.google.protobuf.UInt32ValueOrBuilder
    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.
    com.google.protobuf.Parser<UpstreamTlsContext>
     
    int
     
    SNI string to use when creating TLS backend connections.
    com.google.protobuf.ByteString
    SNI string to use when creating TLS backend connections.
    boolean
    Common TLS context settings. .. attention:: Server certificate verification is not enabled by default.
    boolean
    Controls enforcement of the ``keyUsage`` extension in peer certificates.
    int
     
    boolean
    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.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
     
    final boolean
     
     
     
     
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
     
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    parseFrom(byte[] data)
     
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    parseFrom(com.google.protobuf.ByteString data)
     
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
     
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
     
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<UpstreamTlsContext>
     
     
    void
    writeTo(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, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods 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

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3
    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.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:
      hasCommonTlsContext in interface UpstreamTlsContextOrBuilder
      Returns:
      Whether the commonTlsContext field is set.
    • getCommonTlsContext

      public CommonTlsContext 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:
      getCommonTlsContext in interface UpstreamTlsContextOrBuilder
      Returns:
      The commonTlsContext.
    • getCommonTlsContextOrBuilder

      public CommonTlsContextOrBuilder 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:
      getCommonTlsContextOrBuilder in interface UpstreamTlsContextOrBuilder
    • getSni

      public String getSni()
       SNI string to use when creating TLS backend connections.
       
      string sni = 2 [(.validate.rules) = { ... }
      Specified by:
      getSni in interface UpstreamTlsContextOrBuilder
      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:
      getSniBytes in interface UpstreamTlsContextOrBuilder
      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:
      getAutoHostSni in interface UpstreamTlsContextOrBuilder
      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:
      getAutoSniSanValidation in interface UpstreamTlsContextOrBuilder
      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:
      getAllowRenegotiation in interface UpstreamTlsContextOrBuilder
      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:
      hasMaxSessionKeys in interface UpstreamTlsContextOrBuilder
      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:
      getMaxSessionKeys in interface UpstreamTlsContextOrBuilder
      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:
      getMaxSessionKeysOrBuilder in interface UpstreamTlsContextOrBuilder
    • 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:
      hasEnforceRsaKeyUsage in interface UpstreamTlsContextOrBuilder
      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:
      getEnforceRsaKeyUsage in interface UpstreamTlsContextOrBuilder
      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:
      getEnforceRsaKeyUsageOrBuilder in interface UpstreamTlsContextOrBuilder
    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3
    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException
    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3
    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage
    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.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

      public static UpstreamTlsContext parseFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static UpstreamTlsContext parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static UpstreamTlsContext parseDelimitedFrom(InputStream input) throws IOException
      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

      public UpstreamTlsContext.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite
    • newBuilder

      public static UpstreamTlsContext.Builder newBuilder()
    • newBuilder

      public static UpstreamTlsContext.Builder newBuilder(UpstreamTlsContext prototype)
    • toBuilder

      public UpstreamTlsContext.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite
    • newBuilderForType

      protected UpstreamTlsContext.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3
    • getDefaultInstance

      public static UpstreamTlsContext getDefaultInstance()
    • parser

      public static com.google.protobuf.Parser<UpstreamTlsContext> parser()
    • getParserForType

      public com.google.protobuf.Parser<UpstreamTlsContext> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3
    • getDefaultInstanceForType

      public UpstreamTlsContext getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder