Class UpstreamTlsContext

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
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
@Generated public final class UpstreamTlsContext extends com.google.protobuf.GeneratedMessage implements UpstreamTlsContextOrBuilder
[#next-free-field: 6]
Protobuf type envoy.extensions.transport_sockets.tls.v3.UpstreamTlsContext
See Also:

  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      See Also:

    • bitField0_

      private int bitField0_

    • COMMON_TLS_CONTEXT_FIELD_NUMBER

      public static final int COMMON_TLS_CONTEXT_FIELD_NUMBER
      See Also:

    • commonTlsContext_

      private CommonTlsContext commonTlsContext_

    • SNI_FIELD_NUMBER

      public static final int SNI_FIELD_NUMBER
      See Also:

    • sni_

      private volatile Object sni_

    • ALLOW_RENEGOTIATION_FIELD_NUMBER

      public static final int ALLOW_RENEGOTIATION_FIELD_NUMBER
      See Also:

    • allowRenegotiation_

      private boolean allowRenegotiation_

    • MAX_SESSION_KEYS_FIELD_NUMBER

      public static final int MAX_SESSION_KEYS_FIELD_NUMBER
      See Also:

    • maxSessionKeys_

      private com.google.protobuf.UInt32Value maxSessionKeys_

    • ENFORCE_RSA_KEY_USAGE_FIELD_NUMBER

      public static final int ENFORCE_RSA_KEY_USAGE_FIELD_NUMBER
      See Also:

    • enforceRsaKeyUsage_

      private com.google.protobuf.BoolValue enforceRsaKeyUsage_

    • memoizedIsInitialized

      private byte memoizedIsInitialized

    • DEFAULT_INSTANCE

      private static final UpstreamTlsContext DEFAULT_INSTANCE

    • PARSER

      private static final com.google.protobuf.Parser<UpstreamTlsContext> PARSER

  • Constructor Details

    • UpstreamTlsContext

      private UpstreamTlsContext(com.google.protobuf.GeneratedMessage.Builder<?> builder)

    • UpstreamTlsContext

      private UpstreamTlsContext()

  • Method Details

    • getDescriptor

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

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • hasCommonTlsContext

      public boolean hasCommonTlsContext()
      Common TLS context settings.

.. attention::

Server certificate verification is not enabled by default. Configure
:ref:`trusted_ca<envoy_v3_api_field_extensions.transport_sockets.tls.v3.CertificateValidationContext.trusted_ca>` to enable
verification.
      .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. Configure
:ref:`trusted_ca<envoy_v3_api_field_extensions.transport_sockets.tls.v3.CertificateValidationContext.trusted_ca>` to enable
verification.
      .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. Configure
:ref:`trusted_ca<envoy_v3_api_field_extensions.transport_sockets.tls.v3.CertificateValidationContext.trusted_ca>` to enable
verification.
      .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.

    • 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 store for the purpose of 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 store for the purpose of 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 store for the purpose of 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()
      This field is used to control the enforcement, whereby the handshake will fail if the keyUsage extension
is present and incompatible with the TLS usage. Currently, the default value is false (i.e., enforcement off)
but it is expected to be changed to true by default in a future release.
``ssl.was_key_usage_invalid`` in :ref:`listener metrics <config_listener_stats>` will be set for certificate
configurations that would fail if this option were set to true.
      .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()
      This field is used to control the enforcement, whereby the handshake will fail if the keyUsage extension
is present and incompatible with the TLS usage. Currently, the default value is false (i.e., enforcement off)
but it is expected to be changed to true by default in a future release.
``ssl.was_key_usage_invalid`` in :ref:`listener metrics <config_listener_stats>` will be set for certificate
configurations that would fail if this option were set to true.
      .google.protobuf.BoolValue enforce_rsa_key_usage = 5;
      Specified by:
      getEnforceRsaKeyUsage in interface UpstreamTlsContextOrBuilder
      Returns:
      The enforceRsaKeyUsage.

    • getEnforceRsaKeyUsageOrBuilder

      public com.google.protobuf.BoolValueOrBuilder getEnforceRsaKeyUsageOrBuilder()
      This field is used to control the enforcement, whereby the handshake will fail if the keyUsage extension
is present and incompatible with the TLS usage. Currently, the default value is false (i.e., enforcement off)
but it is expected to be changed to true by default in a future release.
``ssl.was_key_usage_invalid`` in :ref:`listener metrics <config_listener_stats>` will be set for certificate
configurations that would fail if this option were set to true.
      .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.GeneratedMessage

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

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

    • 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.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • 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.GeneratedMessage

    • getDefaultInstanceForType

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