Package io.envoyproxy.envoy.api.v2.auth

Class CommonTlsContext

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.api.v2.auth.CommonTlsContext
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, CommonTlsContextOrBuilder, Serializable
public final class CommonTlsContext extends com.google.protobuf.GeneratedMessageV3 implements CommonTlsContextOrBuilder
 TLS context shared by both client and server TLS contexts.
 [#next-free-field: 9]
Protobuf type envoy.api.v2.auth.CommonTlsContext
See Also:

  • Field Details

    • TLS_PARAMS_FIELD_NUMBER

      public static final int TLS_PARAMS_FIELD_NUMBER
      See Also:

    • TLS_CERTIFICATES_FIELD_NUMBER

      public static final int TLS_CERTIFICATES_FIELD_NUMBER
      See Also:

    • TLS_CERTIFICATE_SDS_SECRET_CONFIGS_FIELD_NUMBER

      public static final int TLS_CERTIFICATE_SDS_SECRET_CONFIGS_FIELD_NUMBER
      See Also:

    • VALIDATION_CONTEXT_FIELD_NUMBER

      public static final int VALIDATION_CONTEXT_FIELD_NUMBER
      See Also:

    • VALIDATION_CONTEXT_SDS_SECRET_CONFIG_FIELD_NUMBER

      public static final int VALIDATION_CONTEXT_SDS_SECRET_CONFIG_FIELD_NUMBER
      See Also:

    • COMBINED_VALIDATION_CONTEXT_FIELD_NUMBER

      public static final int COMBINED_VALIDATION_CONTEXT_FIELD_NUMBER
      See Also:

    • ALPN_PROTOCOLS_FIELD_NUMBER

      public static final int ALPN_PROTOCOLS_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

    • getValidationContextTypeCase

      public CommonTlsContext.ValidationContextTypeCase getValidationContextTypeCase()
      Specified by:
      getValidationContextTypeCase in interface CommonTlsContextOrBuilder

    • hasTlsParams

      public boolean hasTlsParams()
       TLS protocol versions, cipher suites etc.
      .envoy.api.v2.auth.TlsParameters tls_params = 1;
      Specified by:
      hasTlsParams in interface CommonTlsContextOrBuilder
      Returns:
      Whether the tlsParams field is set.

    • getTlsParams

      public TlsParameters getTlsParams()
       TLS protocol versions, cipher suites etc.
      .envoy.api.v2.auth.TlsParameters tls_params = 1;
      Specified by:
      getTlsParams in interface CommonTlsContextOrBuilder
      Returns:
      The tlsParams.

    • getTlsParamsOrBuilder

      public TlsParametersOrBuilder getTlsParamsOrBuilder()
       TLS protocol versions, cipher suites etc.
      .envoy.api.v2.auth.TlsParameters tls_params = 1;
      Specified by:
      getTlsParamsOrBuilder in interface CommonTlsContextOrBuilder

    • getTlsCertificatesList

      public List<TlsCertificate> getTlsCertificatesList()
       :ref:`Multiple TLS certificates <arch_overview_ssl_cert_select>` can be associated with the
 same context to allow both RSA and ECDSA certificates.

 Only a single TLS certificate is supported in client contexts. In server contexts, the first
 RSA certificate is used for clients that only support RSA and the first ECDSA certificate is
 used for clients that support ECDSA.
      repeated .envoy.api.v2.auth.TlsCertificate tls_certificates = 2;
      Specified by:
      getTlsCertificatesList in interface CommonTlsContextOrBuilder

    • getTlsCertificatesOrBuilderList

      public List<? extends TlsCertificateOrBuilder> getTlsCertificatesOrBuilderList()
       :ref:`Multiple TLS certificates <arch_overview_ssl_cert_select>` can be associated with the
 same context to allow both RSA and ECDSA certificates.

 Only a single TLS certificate is supported in client contexts. In server contexts, the first
 RSA certificate is used for clients that only support RSA and the first ECDSA certificate is
 used for clients that support ECDSA.
      repeated .envoy.api.v2.auth.TlsCertificate tls_certificates = 2;
      Specified by:
      getTlsCertificatesOrBuilderList in interface CommonTlsContextOrBuilder

    • getTlsCertificatesCount

      public int getTlsCertificatesCount()
       :ref:`Multiple TLS certificates <arch_overview_ssl_cert_select>` can be associated with the
 same context to allow both RSA and ECDSA certificates.

 Only a single TLS certificate is supported in client contexts. In server contexts, the first
 RSA certificate is used for clients that only support RSA and the first ECDSA certificate is
 used for clients that support ECDSA.
      repeated .envoy.api.v2.auth.TlsCertificate tls_certificates = 2;
      Specified by:
      getTlsCertificatesCount in interface CommonTlsContextOrBuilder

    • getTlsCertificates

      public TlsCertificate getTlsCertificates(int index)
       :ref:`Multiple TLS certificates <arch_overview_ssl_cert_select>` can be associated with the
 same context to allow both RSA and ECDSA certificates.

 Only a single TLS certificate is supported in client contexts. In server contexts, the first
 RSA certificate is used for clients that only support RSA and the first ECDSA certificate is
 used for clients that support ECDSA.
      repeated .envoy.api.v2.auth.TlsCertificate tls_certificates = 2;
      Specified by:
      getTlsCertificates in interface CommonTlsContextOrBuilder

    • getTlsCertificatesOrBuilder

      public TlsCertificateOrBuilder getTlsCertificatesOrBuilder(int index)
       :ref:`Multiple TLS certificates <arch_overview_ssl_cert_select>` can be associated with the
 same context to allow both RSA and ECDSA certificates.

 Only a single TLS certificate is supported in client contexts. In server contexts, the first
 RSA certificate is used for clients that only support RSA and the first ECDSA certificate is
 used for clients that support ECDSA.
      repeated .envoy.api.v2.auth.TlsCertificate tls_certificates = 2;
      Specified by:
      getTlsCertificatesOrBuilder in interface CommonTlsContextOrBuilder

    • getTlsCertificateSdsSecretConfigsList

      public List<SdsSecretConfig> getTlsCertificateSdsSecretConfigsList()
       Configs for fetching TLS certificates via SDS API.
      repeated .envoy.api.v2.auth.SdsSecretConfig tls_certificate_sds_secret_configs = 6 [(.validate.rules) = { ... }
      Specified by:
      getTlsCertificateSdsSecretConfigsList in interface CommonTlsContextOrBuilder

    • getTlsCertificateSdsSecretConfigsOrBuilderList

      public List<? extends SdsSecretConfigOrBuilder> getTlsCertificateSdsSecretConfigsOrBuilderList()
       Configs for fetching TLS certificates via SDS API.
      repeated .envoy.api.v2.auth.SdsSecretConfig tls_certificate_sds_secret_configs = 6 [(.validate.rules) = { ... }
      Specified by:
      getTlsCertificateSdsSecretConfigsOrBuilderList in interface CommonTlsContextOrBuilder

    • getTlsCertificateSdsSecretConfigsCount

      public int getTlsCertificateSdsSecretConfigsCount()
       Configs for fetching TLS certificates via SDS API.
      repeated .envoy.api.v2.auth.SdsSecretConfig tls_certificate_sds_secret_configs = 6 [(.validate.rules) = { ... }
      Specified by:
      getTlsCertificateSdsSecretConfigsCount in interface CommonTlsContextOrBuilder

    • getTlsCertificateSdsSecretConfigs

      public SdsSecretConfig getTlsCertificateSdsSecretConfigs(int index)
       Configs for fetching TLS certificates via SDS API.
      repeated .envoy.api.v2.auth.SdsSecretConfig tls_certificate_sds_secret_configs = 6 [(.validate.rules) = { ... }
      Specified by:
      getTlsCertificateSdsSecretConfigs in interface CommonTlsContextOrBuilder

    • getTlsCertificateSdsSecretConfigsOrBuilder

      public SdsSecretConfigOrBuilder getTlsCertificateSdsSecretConfigsOrBuilder(int index)
       Configs for fetching TLS certificates via SDS API.
      repeated .envoy.api.v2.auth.SdsSecretConfig tls_certificate_sds_secret_configs = 6 [(.validate.rules) = { ... }
      Specified by:
      getTlsCertificateSdsSecretConfigsOrBuilder in interface CommonTlsContextOrBuilder

    • hasValidationContext

      public boolean hasValidationContext()
       How to validate peer certificates.
      .envoy.api.v2.auth.CertificateValidationContext validation_context = 3;
      Specified by:
      hasValidationContext in interface CommonTlsContextOrBuilder
      Returns:
      Whether the validationContext field is set.

    • getValidationContext

      public CertificateValidationContext getValidationContext()
       How to validate peer certificates.
      .envoy.api.v2.auth.CertificateValidationContext validation_context = 3;
      Specified by:
      getValidationContext in interface CommonTlsContextOrBuilder
      Returns:
      The validationContext.

    • getValidationContextOrBuilder

      public CertificateValidationContextOrBuilder getValidationContextOrBuilder()
       How to validate peer certificates.
      .envoy.api.v2.auth.CertificateValidationContext validation_context = 3;
      Specified by:
      getValidationContextOrBuilder in interface CommonTlsContextOrBuilder

    • hasValidationContextSdsSecretConfig

      public boolean hasValidationContextSdsSecretConfig()
       Config for fetching validation context via SDS API.
      .envoy.api.v2.auth.SdsSecretConfig validation_context_sds_secret_config = 7;
      Specified by:
      hasValidationContextSdsSecretConfig in interface CommonTlsContextOrBuilder
      Returns:
      Whether the validationContextSdsSecretConfig field is set.

    • getValidationContextSdsSecretConfig

      public SdsSecretConfig getValidationContextSdsSecretConfig()
       Config for fetching validation context via SDS API.
      .envoy.api.v2.auth.SdsSecretConfig validation_context_sds_secret_config = 7;
      Specified by:
      getValidationContextSdsSecretConfig in interface CommonTlsContextOrBuilder
      Returns:
      The validationContextSdsSecretConfig.

    • getValidationContextSdsSecretConfigOrBuilder

      public SdsSecretConfigOrBuilder getValidationContextSdsSecretConfigOrBuilder()
       Config for fetching validation context via SDS API.
      .envoy.api.v2.auth.SdsSecretConfig validation_context_sds_secret_config = 7;
      Specified by:
      getValidationContextSdsSecretConfigOrBuilder in interface CommonTlsContextOrBuilder

    • hasCombinedValidationContext

      public boolean hasCombinedValidationContext()
       Combined certificate validation context holds a default CertificateValidationContext
 and SDS config. When SDS server returns dynamic CertificateValidationContext, both dynamic
 and default CertificateValidationContext are merged into a new CertificateValidationContext
 for validation. This merge is done by Message::MergeFrom(), so dynamic
 CertificateValidationContext overwrites singular fields in default
 CertificateValidationContext, and concatenates repeated fields to default
 CertificateValidationContext, and logical OR is applied to boolean fields.
      .envoy.api.v2.auth.CommonTlsContext.CombinedCertificateValidationContext combined_validation_context = 8;
      Specified by:
      hasCombinedValidationContext in interface CommonTlsContextOrBuilder
      Returns:
      Whether the combinedValidationContext field is set.

    • getCombinedValidationContext

      public CommonTlsContext.CombinedCertificateValidationContext getCombinedValidationContext()
       Combined certificate validation context holds a default CertificateValidationContext
 and SDS config. When SDS server returns dynamic CertificateValidationContext, both dynamic
 and default CertificateValidationContext are merged into a new CertificateValidationContext
 for validation. This merge is done by Message::MergeFrom(), so dynamic
 CertificateValidationContext overwrites singular fields in default
 CertificateValidationContext, and concatenates repeated fields to default
 CertificateValidationContext, and logical OR is applied to boolean fields.
      .envoy.api.v2.auth.CommonTlsContext.CombinedCertificateValidationContext combined_validation_context = 8;
      Specified by:
      getCombinedValidationContext in interface CommonTlsContextOrBuilder
      Returns:
      The combinedValidationContext.

    • getCombinedValidationContextOrBuilder

      public CommonTlsContext.CombinedCertificateValidationContextOrBuilder getCombinedValidationContextOrBuilder()
       Combined certificate validation context holds a default CertificateValidationContext
 and SDS config. When SDS server returns dynamic CertificateValidationContext, both dynamic
 and default CertificateValidationContext are merged into a new CertificateValidationContext
 for validation. This merge is done by Message::MergeFrom(), so dynamic
 CertificateValidationContext overwrites singular fields in default
 CertificateValidationContext, and concatenates repeated fields to default
 CertificateValidationContext, and logical OR is applied to boolean fields.
      .envoy.api.v2.auth.CommonTlsContext.CombinedCertificateValidationContext combined_validation_context = 8;
      Specified by:
      getCombinedValidationContextOrBuilder in interface CommonTlsContextOrBuilder

    • getAlpnProtocolsList

      public com.google.protobuf.ProtocolStringList getAlpnProtocolsList()
       Supplies the list of ALPN protocols that the listener should expose. In
 practice this is likely to be set to one of two values (see the
 :ref:`codec_type
 <envoy_api_field_config.filter.network.http_connection_manager.v2.HttpConnectionManager.codec_type>`
 parameter in the HTTP connection manager for more information):

 * "h2,http/1.1" If the listener is going to support both HTTP/2 and HTTP/1.1.
 * "http/1.1" If the listener is only going to support HTTP/1.1.

 There is no default for this parameter. If empty, Envoy will not expose ALPN.
      repeated string alpn_protocols = 4;
      Specified by:
      getAlpnProtocolsList in interface CommonTlsContextOrBuilder
      Returns:
      A list containing the alpnProtocols.

    • getAlpnProtocolsCount

      public int getAlpnProtocolsCount()
       Supplies the list of ALPN protocols that the listener should expose. In
 practice this is likely to be set to one of two values (see the
 :ref:`codec_type
 <envoy_api_field_config.filter.network.http_connection_manager.v2.HttpConnectionManager.codec_type>`
 parameter in the HTTP connection manager for more information):

 * "h2,http/1.1" If the listener is going to support both HTTP/2 and HTTP/1.1.
 * "http/1.1" If the listener is only going to support HTTP/1.1.

 There is no default for this parameter. If empty, Envoy will not expose ALPN.
      repeated string alpn_protocols = 4;
      Specified by:
      getAlpnProtocolsCount in interface CommonTlsContextOrBuilder
      Returns:
      The count of alpnProtocols.

    • getAlpnProtocols

      public String getAlpnProtocols(int index)
       Supplies the list of ALPN protocols that the listener should expose. In
 practice this is likely to be set to one of two values (see the
 :ref:`codec_type
 <envoy_api_field_config.filter.network.http_connection_manager.v2.HttpConnectionManager.codec_type>`
 parameter in the HTTP connection manager for more information):

 * "h2,http/1.1" If the listener is going to support both HTTP/2 and HTTP/1.1.
 * "http/1.1" If the listener is only going to support HTTP/1.1.

 There is no default for this parameter. If empty, Envoy will not expose ALPN.
      repeated string alpn_protocols = 4;
      Specified by:
      getAlpnProtocols in interface CommonTlsContextOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The alpnProtocols at the given index.

    • getAlpnProtocolsBytes

      public com.google.protobuf.ByteString getAlpnProtocolsBytes(int index)
       Supplies the list of ALPN protocols that the listener should expose. In
 practice this is likely to be set to one of two values (see the
 :ref:`codec_type
 <envoy_api_field_config.filter.network.http_connection_manager.v2.HttpConnectionManager.codec_type>`
 parameter in the HTTP connection manager for more information):

 * "h2,http/1.1" If the listener is going to support both HTTP/2 and HTTP/1.1.
 * "http/1.1" If the listener is only going to support HTTP/1.1.

 There is no default for this parameter. If empty, Envoy will not expose ALPN.
      repeated string alpn_protocols = 4;
      Specified by:
      getAlpnProtocolsBytes in interface CommonTlsContextOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the alpnProtocols at the given index.

    • 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 CommonTlsContext parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CommonTlsContext parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CommonTlsContext parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CommonTlsContext parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CommonTlsContext parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CommonTlsContext parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CommonTlsContext parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static CommonTlsContext parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

      public static CommonTlsContext parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static CommonTlsContext parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static CommonTlsContext.Builder newBuilder()

    • newBuilder

      public static CommonTlsContext.Builder newBuilder(CommonTlsContext prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static CommonTlsContext getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<CommonTlsContext> parser()

    • getParserForType

      public com.google.protobuf.Parser<CommonTlsContext> 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 CommonTlsContext getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder