Class CertificateValidationContext
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite
-
- com.google.protobuf.AbstractMessage
-
- com.google.protobuf.GeneratedMessageV3
-
- io.envoyproxy.envoy.extensions.transport_sockets.tls.v3.CertificateValidationContext
-
- All Implemented Interfaces:
com.google.protobuf.Message,com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,CertificateValidationContextOrBuilder,Serializable
public final class CertificateValidationContext extends com.google.protobuf.GeneratedMessageV3 implements CertificateValidationContextOrBuilder
[#next-free-field: 17]
Protobuf typeenvoy.extensions.transport_sockets.tls.v3.CertificateValidationContext- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classCertificateValidationContext.Builder[#next-free-field: 17]static classCertificateValidationContext.TrustChainVerificationPeer certificate verification mode.-
Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
-
-
Field Summary
Fields Modifier and Type Field Description static intALLOW_EXPIRED_CERTIFICATE_FIELD_NUMBERstatic intCA_CERTIFICATE_PROVIDER_INSTANCE_FIELD_NUMBERstatic intCRL_FIELD_NUMBERstatic intCUSTOM_VALIDATOR_CONFIG_FIELD_NUMBERstatic intMATCH_SUBJECT_ALT_NAMES_FIELD_NUMBERstatic intMATCH_TYPED_SUBJECT_ALT_NAMES_FIELD_NUMBERstatic intMAX_VERIFY_DEPTH_FIELD_NUMBERstatic intONLY_VERIFY_LEAF_CERT_CRL_FIELD_NUMBERstatic intREQUIRE_SIGNED_CERTIFICATE_TIMESTAMP_FIELD_NUMBERstatic intTRUST_CHAIN_VERIFICATION_FIELD_NUMBERstatic intTRUSTED_CA_FIELD_NUMBERstatic intVERIFY_CERTIFICATE_HASH_FIELD_NUMBERstatic intVERIFY_CERTIFICATE_SPKI_FIELD_NUMBERstatic intWATCHED_DIRECTORY_FIELD_NUMBER
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description booleanequals(Object obj)booleangetAllowExpiredCertificate()If specified, Envoy will not reject expired certificates.CertificateProviderPluginInstancegetCaCertificateProviderInstance()Certificate provider instance for fetching TLS certificates.CertificateProviderPluginInstanceOrBuildergetCaCertificateProviderInstanceOrBuilder()Certificate provider instance for fetching TLS certificates.DataSourcegetCrl()An optional `certificate revocation list <https://en.wikipedia.org/wiki/Certificate_revocation_list>`_ (in PEM format).DataSourceOrBuildergetCrlOrBuilder()An optional `certificate revocation list <https://en.wikipedia.org/wiki/Certificate_revocation_list>`_ (in PEM format).TypedExtensionConfiggetCustomValidatorConfig()The configuration of an extension specific certificate validator.TypedExtensionConfigOrBuildergetCustomValidatorConfigOrBuilder()The configuration of an extension specific certificate validator.static CertificateValidationContextgetDefaultInstance()CertificateValidationContextgetDefaultInstanceForType()static com.google.protobuf.Descriptors.DescriptorgetDescriptor()StringMatchergetMatchSubjectAltNames(int index)Deprecated.intgetMatchSubjectAltNamesCount()Deprecated.List<StringMatcher>getMatchSubjectAltNamesList()Deprecated.StringMatcherOrBuildergetMatchSubjectAltNamesOrBuilder(int index)Deprecated.List<? extends StringMatcherOrBuilder>getMatchSubjectAltNamesOrBuilderList()Deprecated.SubjectAltNameMatchergetMatchTypedSubjectAltNames(int index)An optional list of Subject Alternative name matchers.intgetMatchTypedSubjectAltNamesCount()An optional list of Subject Alternative name matchers.List<SubjectAltNameMatcher>getMatchTypedSubjectAltNamesList()An optional list of Subject Alternative name matchers.SubjectAltNameMatcherOrBuildergetMatchTypedSubjectAltNamesOrBuilder(int index)An optional list of Subject Alternative name matchers.List<? extends SubjectAltNameMatcherOrBuilder>getMatchTypedSubjectAltNamesOrBuilderList()An optional list of Subject Alternative name matchers.com.google.protobuf.UInt32ValuegetMaxVerifyDepth()Config for the max number of intermediate certificates in chain that are parsed during verification.com.google.protobuf.UInt32ValueOrBuildergetMaxVerifyDepthOrBuilder()Config for the max number of intermediate certificates in chain that are parsed during verification.booleangetOnlyVerifyLeafCertCrl()If this option is set to true, only the certificate at the end of the certificate chain will be subject to validation by :ref:`CRL <envoy_v3_api_field_extensions.transport_sockets.tls.v3.CertificateValidationContext.crl>`.com.google.protobuf.Parser<CertificateValidationContext>getParserForType()com.google.protobuf.BoolValuegetRequireSignedCertificateTimestamp()[#not-implemented-hide:] Must present signed certificate time-stamp.com.google.protobuf.BoolValueOrBuildergetRequireSignedCertificateTimestampOrBuilder()[#not-implemented-hide:] Must present signed certificate time-stamp.intgetSerializedSize()CertificateValidationContext.TrustChainVerificationgetTrustChainVerification()Certificate trust chain verification mode.intgetTrustChainVerificationValue()Certificate trust chain verification mode.DataSourcegetTrustedCa()TLS certificate data containing certificate authority certificates to use in verifying a presented peer certificate (e.g. server certificate for clusters or client certificate for listeners).DataSourceOrBuildergetTrustedCaOrBuilder()TLS certificate data containing certificate authority certificates to use in verifying a presented peer certificate (e.g. server certificate for clusters or client certificate for listeners).com.google.protobuf.UnknownFieldSetgetUnknownFields()StringgetVerifyCertificateHash(int index)An optional list of hex-encoded SHA-256 hashes.com.google.protobuf.ByteStringgetVerifyCertificateHashBytes(int index)An optional list of hex-encoded SHA-256 hashes.intgetVerifyCertificateHashCount()An optional list of hex-encoded SHA-256 hashes.com.google.protobuf.ProtocolStringListgetVerifyCertificateHashList()An optional list of hex-encoded SHA-256 hashes.StringgetVerifyCertificateSpki(int index)An optional list of base64-encoded SHA-256 hashes.com.google.protobuf.ByteStringgetVerifyCertificateSpkiBytes(int index)An optional list of base64-encoded SHA-256 hashes.intgetVerifyCertificateSpkiCount()An optional list of base64-encoded SHA-256 hashes.com.google.protobuf.ProtocolStringListgetVerifyCertificateSpkiList()An optional list of base64-encoded SHA-256 hashes.WatchedDirectorygetWatchedDirectory()If specified, updates of a file-based ``trusted_ca`` source will be triggered by this watch.WatchedDirectoryOrBuildergetWatchedDirectoryOrBuilder()If specified, updates of a file-based ``trusted_ca`` source will be triggered by this watch.booleanhasCaCertificateProviderInstance()Certificate provider instance for fetching TLS certificates.booleanhasCrl()An optional `certificate revocation list <https://en.wikipedia.org/wiki/Certificate_revocation_list>`_ (in PEM format).booleanhasCustomValidatorConfig()The configuration of an extension specific certificate validator.inthashCode()booleanhasMaxVerifyDepth()Config for the max number of intermediate certificates in chain that are parsed during verification.booleanhasRequireSignedCertificateTimestamp()[#not-implemented-hide:] Must present signed certificate time-stamp.booleanhasTrustedCa()TLS certificate data containing certificate authority certificates to use in verifying a presented peer certificate (e.g. server certificate for clusters or client certificate for listeners).booleanhasWatchedDirectory()If specified, updates of a file-based ``trusted_ca`` source will be triggered by this watch.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()booleanisInitialized()static CertificateValidationContext.BuildernewBuilder()static CertificateValidationContext.BuildernewBuilder(CertificateValidationContext prototype)CertificateValidationContext.BuildernewBuilderForType()protected CertificateValidationContext.BuildernewBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)protected ObjectnewInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)static CertificateValidationContextparseDelimitedFrom(InputStream input)static CertificateValidationContextparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static CertificateValidationContextparseFrom(byte[] data)static CertificateValidationContextparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static CertificateValidationContextparseFrom(com.google.protobuf.ByteString data)static CertificateValidationContextparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static CertificateValidationContextparseFrom(com.google.protobuf.CodedInputStream input)static CertificateValidationContextparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static CertificateValidationContextparseFrom(InputStream input)static CertificateValidationContextparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static CertificateValidationContextparseFrom(ByteBuffer data)static CertificateValidationContextparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static com.google.protobuf.Parser<CertificateValidationContext>parser()CertificateValidationContext.BuildertoBuilder()voidwriteTo(com.google.protobuf.CodedOutputStream output)-
Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, 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
-
-
-
-
Field Detail
-
TRUSTED_CA_FIELD_NUMBER
public static final int TRUSTED_CA_FIELD_NUMBER
- See Also:
- Constant Field Values
-
CA_CERTIFICATE_PROVIDER_INSTANCE_FIELD_NUMBER
public static final int CA_CERTIFICATE_PROVIDER_INSTANCE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
WATCHED_DIRECTORY_FIELD_NUMBER
public static final int WATCHED_DIRECTORY_FIELD_NUMBER
- See Also:
- Constant Field Values
-
VERIFY_CERTIFICATE_SPKI_FIELD_NUMBER
public static final int VERIFY_CERTIFICATE_SPKI_FIELD_NUMBER
- See Also:
- Constant Field Values
-
VERIFY_CERTIFICATE_HASH_FIELD_NUMBER
public static final int VERIFY_CERTIFICATE_HASH_FIELD_NUMBER
- See Also:
- Constant Field Values
-
MATCH_TYPED_SUBJECT_ALT_NAMES_FIELD_NUMBER
public static final int MATCH_TYPED_SUBJECT_ALT_NAMES_FIELD_NUMBER
- See Also:
- Constant Field Values
-
MATCH_SUBJECT_ALT_NAMES_FIELD_NUMBER
public static final int MATCH_SUBJECT_ALT_NAMES_FIELD_NUMBER
- See Also:
- Constant Field Values
-
REQUIRE_SIGNED_CERTIFICATE_TIMESTAMP_FIELD_NUMBER
public static final int REQUIRE_SIGNED_CERTIFICATE_TIMESTAMP_FIELD_NUMBER
- See Also:
- Constant Field Values
-
CRL_FIELD_NUMBER
public static final int CRL_FIELD_NUMBER
- See Also:
- Constant Field Values
-
ALLOW_EXPIRED_CERTIFICATE_FIELD_NUMBER
public static final int ALLOW_EXPIRED_CERTIFICATE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
TRUST_CHAIN_VERIFICATION_FIELD_NUMBER
public static final int TRUST_CHAIN_VERIFICATION_FIELD_NUMBER
- See Also:
- Constant Field Values
-
CUSTOM_VALIDATOR_CONFIG_FIELD_NUMBER
public static final int CUSTOM_VALIDATOR_CONFIG_FIELD_NUMBER
- See Also:
- Constant Field Values
-
ONLY_VERIFY_LEAF_CERT_CRL_FIELD_NUMBER
public static final int ONLY_VERIFY_LEAF_CERT_CRL_FIELD_NUMBER
- See Also:
- Constant Field Values
-
MAX_VERIFY_DEPTH_FIELD_NUMBER
public static final int MAX_VERIFY_DEPTH_FIELD_NUMBER
- See Also:
- Constant Field Values
-
-
Method Detail
-
newInstance
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
- Overrides:
newInstancein classcom.google.protobuf.GeneratedMessageV3
-
getUnknownFields
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
- Specified by:
getUnknownFieldsin interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getUnknownFieldsin 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
-
hasTrustedCa
public boolean hasTrustedCa()
TLS certificate data containing certificate authority certificates to use in verifying a presented peer certificate (e.g. server certificate for clusters or client certificate for listeners). If not specified and a peer certificate is presented it will not be verified. By default, a client certificate is optional, unless one of the additional options (:ref:`require_client_certificate <envoy_v3_api_field_extensions.transport_sockets.tls.v3.DownstreamTlsContext.require_client_certificate>`, :ref:`verify_certificate_spki <envoy_v3_api_field_extensions.transport_sockets.tls.v3.CertificateValidationContext.verify_certificate_spki>`, :ref:`verify_certificate_hash <envoy_v3_api_field_extensions.transport_sockets.tls.v3.CertificateValidationContext.verify_certificate_hash>`, or :ref:`match_typed_subject_alt_names <envoy_v3_api_field_extensions.transport_sockets.tls.v3.CertificateValidationContext.match_typed_subject_alt_names>`) is also specified. It can optionally contain certificate revocation lists, in which case Envoy will verify that the presented peer certificate has not been revoked by one of the included CRLs. Note that if a CRL is provided for any certificate authority in a trust chain, a CRL must be provided for all certificate authorities in that chain. Failure to do so will result in verification failure for both revoked and unrevoked certificates from that chain. The behavior of requiring all certificates to contain CRLs if any do can be altered by setting :ref:`only_verify_leaf_cert_crl <envoy_v3_api_field_extensions.transport_sockets.tls.v3.CertificateValidationContext.only_verify_leaf_cert_crl>` true. If set to true, only the final certificate in the chain undergoes CRL verification. See :ref:`the TLS overview <arch_overview_ssl_enabling_verification>` for a list of common system CA locations. If ``trusted_ca`` is a filesystem path, a watch will be added to the parent directory for any file moves to support rotation. This currently only applies to dynamic secrets, when the ``CertificateValidationContext`` is delivered via SDS. Only one of ``trusted_ca`` and ``ca_certificate_provider_instance`` may be specified. [#next-major-version: This field and watched_directory below should ideally be moved into a separate sub-message, since there's no point in specifying the latter field without this one.]
.envoy.config.core.v3.DataSource trusted_ca = 1 [(.udpa.annotations.field_migrate) = { ... }- Specified by:
hasTrustedCain interfaceCertificateValidationContextOrBuilder- Returns:
- Whether the trustedCa field is set.
-
getTrustedCa
public DataSource getTrustedCa()
TLS certificate data containing certificate authority certificates to use in verifying a presented peer certificate (e.g. server certificate for clusters or client certificate for listeners). If not specified and a peer certificate is presented it will not be verified. By default, a client certificate is optional, unless one of the additional options (:ref:`require_client_certificate <envoy_v3_api_field_extensions.transport_sockets.tls.v3.DownstreamTlsContext.require_client_certificate>`, :ref:`verify_certificate_spki <envoy_v3_api_field_extensions.transport_sockets.tls.v3.CertificateValidationContext.verify_certificate_spki>`, :ref:`verify_certificate_hash <envoy_v3_api_field_extensions.transport_sockets.tls.v3.CertificateValidationContext.verify_certificate_hash>`, or :ref:`match_typed_subject_alt_names <envoy_v3_api_field_extensions.transport_sockets.tls.v3.CertificateValidationContext.match_typed_subject_alt_names>`) is also specified. It can optionally contain certificate revocation lists, in which case Envoy will verify that the presented peer certificate has not been revoked by one of the included CRLs. Note that if a CRL is provided for any certificate authority in a trust chain, a CRL must be provided for all certificate authorities in that chain. Failure to do so will result in verification failure for both revoked and unrevoked certificates from that chain. The behavior of requiring all certificates to contain CRLs if any do can be altered by setting :ref:`only_verify_leaf_cert_crl <envoy_v3_api_field_extensions.transport_sockets.tls.v3.CertificateValidationContext.only_verify_leaf_cert_crl>` true. If set to true, only the final certificate in the chain undergoes CRL verification. See :ref:`the TLS overview <arch_overview_ssl_enabling_verification>` for a list of common system CA locations. If ``trusted_ca`` is a filesystem path, a watch will be added to the parent directory for any file moves to support rotation. This currently only applies to dynamic secrets, when the ``CertificateValidationContext`` is delivered via SDS. Only one of ``trusted_ca`` and ``ca_certificate_provider_instance`` may be specified. [#next-major-version: This field and watched_directory below should ideally be moved into a separate sub-message, since there's no point in specifying the latter field without this one.]
.envoy.config.core.v3.DataSource trusted_ca = 1 [(.udpa.annotations.field_migrate) = { ... }- Specified by:
getTrustedCain interfaceCertificateValidationContextOrBuilder- Returns:
- The trustedCa.
-
getTrustedCaOrBuilder
public DataSourceOrBuilder getTrustedCaOrBuilder()
TLS certificate data containing certificate authority certificates to use in verifying a presented peer certificate (e.g. server certificate for clusters or client certificate for listeners). If not specified and a peer certificate is presented it will not be verified. By default, a client certificate is optional, unless one of the additional options (:ref:`require_client_certificate <envoy_v3_api_field_extensions.transport_sockets.tls.v3.DownstreamTlsContext.require_client_certificate>`, :ref:`verify_certificate_spki <envoy_v3_api_field_extensions.transport_sockets.tls.v3.CertificateValidationContext.verify_certificate_spki>`, :ref:`verify_certificate_hash <envoy_v3_api_field_extensions.transport_sockets.tls.v3.CertificateValidationContext.verify_certificate_hash>`, or :ref:`match_typed_subject_alt_names <envoy_v3_api_field_extensions.transport_sockets.tls.v3.CertificateValidationContext.match_typed_subject_alt_names>`) is also specified. It can optionally contain certificate revocation lists, in which case Envoy will verify that the presented peer certificate has not been revoked by one of the included CRLs. Note that if a CRL is provided for any certificate authority in a trust chain, a CRL must be provided for all certificate authorities in that chain. Failure to do so will result in verification failure for both revoked and unrevoked certificates from that chain. The behavior of requiring all certificates to contain CRLs if any do can be altered by setting :ref:`only_verify_leaf_cert_crl <envoy_v3_api_field_extensions.transport_sockets.tls.v3.CertificateValidationContext.only_verify_leaf_cert_crl>` true. If set to true, only the final certificate in the chain undergoes CRL verification. See :ref:`the TLS overview <arch_overview_ssl_enabling_verification>` for a list of common system CA locations. If ``trusted_ca`` is a filesystem path, a watch will be added to the parent directory for any file moves to support rotation. This currently only applies to dynamic secrets, when the ``CertificateValidationContext`` is delivered via SDS. Only one of ``trusted_ca`` and ``ca_certificate_provider_instance`` may be specified. [#next-major-version: This field and watched_directory below should ideally be moved into a separate sub-message, since there's no point in specifying the latter field without this one.]
.envoy.config.core.v3.DataSource trusted_ca = 1 [(.udpa.annotations.field_migrate) = { ... }- Specified by:
getTrustedCaOrBuilderin interfaceCertificateValidationContextOrBuilder
-
hasCaCertificateProviderInstance
public boolean hasCaCertificateProviderInstance()
Certificate provider instance for fetching TLS certificates. Only one of ``trusted_ca`` and ``ca_certificate_provider_instance`` may be specified. [#not-implemented-hide:]
.envoy.extensions.transport_sockets.tls.v3.CertificateProviderPluginInstance ca_certificate_provider_instance = 13 [(.udpa.annotations.field_migrate) = { ... }- Specified by:
hasCaCertificateProviderInstancein interfaceCertificateValidationContextOrBuilder- Returns:
- Whether the caCertificateProviderInstance field is set.
-
getCaCertificateProviderInstance
public CertificateProviderPluginInstance getCaCertificateProviderInstance()
Certificate provider instance for fetching TLS certificates. Only one of ``trusted_ca`` and ``ca_certificate_provider_instance`` may be specified. [#not-implemented-hide:]
.envoy.extensions.transport_sockets.tls.v3.CertificateProviderPluginInstance ca_certificate_provider_instance = 13 [(.udpa.annotations.field_migrate) = { ... }- Specified by:
getCaCertificateProviderInstancein interfaceCertificateValidationContextOrBuilder- Returns:
- The caCertificateProviderInstance.
-
getCaCertificateProviderInstanceOrBuilder
public CertificateProviderPluginInstanceOrBuilder getCaCertificateProviderInstanceOrBuilder()
Certificate provider instance for fetching TLS certificates. Only one of ``trusted_ca`` and ``ca_certificate_provider_instance`` may be specified. [#not-implemented-hide:]
.envoy.extensions.transport_sockets.tls.v3.CertificateProviderPluginInstance ca_certificate_provider_instance = 13 [(.udpa.annotations.field_migrate) = { ... }- Specified by:
getCaCertificateProviderInstanceOrBuilderin interfaceCertificateValidationContextOrBuilder
-
hasWatchedDirectory
public boolean hasWatchedDirectory()
If specified, updates of a file-based ``trusted_ca`` source will be triggered by this watch. This allows explicit control over the path watched, by default the parent directory of the filesystem path in ``trusted_ca`` is watched if this field is not specified. This only applies when a ``CertificateValidationContext`` is delivered by SDS with references to filesystem paths. See the :ref:`SDS key rotation <sds_key_rotation>` documentation for further details.
.envoy.config.core.v3.WatchedDirectory watched_directory = 11;- Specified by:
hasWatchedDirectoryin interfaceCertificateValidationContextOrBuilder- Returns:
- Whether the watchedDirectory field is set.
-
getWatchedDirectory
public WatchedDirectory getWatchedDirectory()
If specified, updates of a file-based ``trusted_ca`` source will be triggered by this watch. This allows explicit control over the path watched, by default the parent directory of the filesystem path in ``trusted_ca`` is watched if this field is not specified. This only applies when a ``CertificateValidationContext`` is delivered by SDS with references to filesystem paths. See the :ref:`SDS key rotation <sds_key_rotation>` documentation for further details.
.envoy.config.core.v3.WatchedDirectory watched_directory = 11;- Specified by:
getWatchedDirectoryin interfaceCertificateValidationContextOrBuilder- Returns:
- The watchedDirectory.
-
getWatchedDirectoryOrBuilder
public WatchedDirectoryOrBuilder getWatchedDirectoryOrBuilder()
If specified, updates of a file-based ``trusted_ca`` source will be triggered by this watch. This allows explicit control over the path watched, by default the parent directory of the filesystem path in ``trusted_ca`` is watched if this field is not specified. This only applies when a ``CertificateValidationContext`` is delivered by SDS with references to filesystem paths. See the :ref:`SDS key rotation <sds_key_rotation>` documentation for further details.
.envoy.config.core.v3.WatchedDirectory watched_directory = 11;- Specified by:
getWatchedDirectoryOrBuilderin interfaceCertificateValidationContextOrBuilder
-
getVerifyCertificateSpkiList
public com.google.protobuf.ProtocolStringList getVerifyCertificateSpkiList()
An optional list of base64-encoded SHA-256 hashes. If specified, Envoy will verify that the SHA-256 of the DER-encoded Subject Public Key Information (SPKI) of the presented certificate matches one of the specified values. A base64-encoded SHA-256 of the Subject Public Key Information (SPKI) of the certificate can be generated with the following command: .. code-block:: bash $ openssl x509 -in path/to/client.crt -noout -pubkey | openssl pkey -pubin -outform DER | openssl dgst -sha256 -binary | openssl enc -base64 NvqYIYSbgK2vCJpQhObf77vv+bQWtc5ek5RIOwPiC9A= This is the format used in HTTP Public Key Pinning. When both: :ref:`verify_certificate_hash <envoy_v3_api_field_extensions.transport_sockets.tls.v3.CertificateValidationContext.verify_certificate_hash>` and :ref:`verify_certificate_spki <envoy_v3_api_field_extensions.transport_sockets.tls.v3.CertificateValidationContext.verify_certificate_spki>` are specified, a hash matching value from either of the lists will result in the certificate being accepted. .. attention:: This option is preferred over :ref:`verify_certificate_hash <envoy_v3_api_field_extensions.transport_sockets.tls.v3.CertificateValidationContext.verify_certificate_hash>`, because SPKI is tied to a private key, so it doesn't change when the certificate is renewed using the same private key.repeated string verify_certificate_spki = 3 [(.validate.rules) = { ... }- Specified by:
getVerifyCertificateSpkiListin interfaceCertificateValidationContextOrBuilder- Returns:
- A list containing the verifyCertificateSpki.
-
getVerifyCertificateSpkiCount
public int getVerifyCertificateSpkiCount()
An optional list of base64-encoded SHA-256 hashes. If specified, Envoy will verify that the SHA-256 of the DER-encoded Subject Public Key Information (SPKI) of the presented certificate matches one of the specified values. A base64-encoded SHA-256 of the Subject Public Key Information (SPKI) of the certificate can be generated with the following command: .. code-block:: bash $ openssl x509 -in path/to/client.crt -noout -pubkey | openssl pkey -pubin -outform DER | openssl dgst -sha256 -binary | openssl enc -base64 NvqYIYSbgK2vCJpQhObf77vv+bQWtc5ek5RIOwPiC9A= This is the format used in HTTP Public Key Pinning. When both: :ref:`verify_certificate_hash <envoy_v3_api_field_extensions.transport_sockets.tls.v3.CertificateValidationContext.verify_certificate_hash>` and :ref:`verify_certificate_spki <envoy_v3_api_field_extensions.transport_sockets.tls.v3.CertificateValidationContext.verify_certificate_spki>` are specified, a hash matching value from either of the lists will result in the certificate being accepted. .. attention:: This option is preferred over :ref:`verify_certificate_hash <envoy_v3_api_field_extensions.transport_sockets.tls.v3.CertificateValidationContext.verify_certificate_hash>`, because SPKI is tied to a private key, so it doesn't change when the certificate is renewed using the same private key.repeated string verify_certificate_spki = 3 [(.validate.rules) = { ... }- Specified by:
getVerifyCertificateSpkiCountin interfaceCertificateValidationContextOrBuilder- Returns:
- The count of verifyCertificateSpki.
-
getVerifyCertificateSpki
public String getVerifyCertificateSpki(int index)
An optional list of base64-encoded SHA-256 hashes. If specified, Envoy will verify that the SHA-256 of the DER-encoded Subject Public Key Information (SPKI) of the presented certificate matches one of the specified values. A base64-encoded SHA-256 of the Subject Public Key Information (SPKI) of the certificate can be generated with the following command: .. code-block:: bash $ openssl x509 -in path/to/client.crt -noout -pubkey | openssl pkey -pubin -outform DER | openssl dgst -sha256 -binary | openssl enc -base64 NvqYIYSbgK2vCJpQhObf77vv+bQWtc5ek5RIOwPiC9A= This is the format used in HTTP Public Key Pinning. When both: :ref:`verify_certificate_hash <envoy_v3_api_field_extensions.transport_sockets.tls.v3.CertificateValidationContext.verify_certificate_hash>` and :ref:`verify_certificate_spki <envoy_v3_api_field_extensions.transport_sockets.tls.v3.CertificateValidationContext.verify_certificate_spki>` are specified, a hash matching value from either of the lists will result in the certificate being accepted. .. attention:: This option is preferred over :ref:`verify_certificate_hash <envoy_v3_api_field_extensions.transport_sockets.tls.v3.CertificateValidationContext.verify_certificate_hash>`, because SPKI is tied to a private key, so it doesn't change when the certificate is renewed using the same private key.repeated string verify_certificate_spki = 3 [(.validate.rules) = { ... }- Specified by:
getVerifyCertificateSpkiin interfaceCertificateValidationContextOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The verifyCertificateSpki at the given index.
-
getVerifyCertificateSpkiBytes
public com.google.protobuf.ByteString getVerifyCertificateSpkiBytes(int index)
An optional list of base64-encoded SHA-256 hashes. If specified, Envoy will verify that the SHA-256 of the DER-encoded Subject Public Key Information (SPKI) of the presented certificate matches one of the specified values. A base64-encoded SHA-256 of the Subject Public Key Information (SPKI) of the certificate can be generated with the following command: .. code-block:: bash $ openssl x509 -in path/to/client.crt -noout -pubkey | openssl pkey -pubin -outform DER | openssl dgst -sha256 -binary | openssl enc -base64 NvqYIYSbgK2vCJpQhObf77vv+bQWtc5ek5RIOwPiC9A= This is the format used in HTTP Public Key Pinning. When both: :ref:`verify_certificate_hash <envoy_v3_api_field_extensions.transport_sockets.tls.v3.CertificateValidationContext.verify_certificate_hash>` and :ref:`verify_certificate_spki <envoy_v3_api_field_extensions.transport_sockets.tls.v3.CertificateValidationContext.verify_certificate_spki>` are specified, a hash matching value from either of the lists will result in the certificate being accepted. .. attention:: This option is preferred over :ref:`verify_certificate_hash <envoy_v3_api_field_extensions.transport_sockets.tls.v3.CertificateValidationContext.verify_certificate_hash>`, because SPKI is tied to a private key, so it doesn't change when the certificate is renewed using the same private key.repeated string verify_certificate_spki = 3 [(.validate.rules) = { ... }- Specified by:
getVerifyCertificateSpkiBytesin interfaceCertificateValidationContextOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the verifyCertificateSpki at the given index.
-
getVerifyCertificateHashList
public com.google.protobuf.ProtocolStringList getVerifyCertificateHashList()
An optional list of hex-encoded SHA-256 hashes. If specified, Envoy will verify that the SHA-256 of the DER-encoded presented certificate matches one of the specified values. A hex-encoded SHA-256 of the certificate can be generated with the following command: .. code-block:: bash $ openssl x509 -in path/to/client.crt -outform DER | openssl dgst -sha256 | cut -d" " -f2 df6ff72fe9116521268f6f2dd4966f51df479883fe7037b39f75916ac3049d1a A long hex-encoded and colon-separated SHA-256 (a.k.a. "fingerprint") of the certificate can be generated with the following command: .. code-block:: bash $ openssl x509 -in path/to/client.crt -noout -fingerprint -sha256 | cut -d"=" -f2 DF:6F:F7:2F:E9:11:65:21:26:8F:6F:2D:D4:96:6F:51:DF:47:98:83:FE:70:37:B3:9F:75:91:6A:C3:04:9D:1A Both of those formats are acceptable. When both: :ref:`verify_certificate_hash <envoy_v3_api_field_extensions.transport_sockets.tls.v3.CertificateValidationContext.verify_certificate_hash>` and :ref:`verify_certificate_spki <envoy_v3_api_field_extensions.transport_sockets.tls.v3.CertificateValidationContext.verify_certificate_spki>` are specified, a hash matching value from either of the lists will result in the certificate being accepted.
repeated string verify_certificate_hash = 2 [(.validate.rules) = { ... }- Specified by:
getVerifyCertificateHashListin interfaceCertificateValidationContextOrBuilder- Returns:
- A list containing the verifyCertificateHash.
-
getVerifyCertificateHashCount
public int getVerifyCertificateHashCount()
An optional list of hex-encoded SHA-256 hashes. If specified, Envoy will verify that the SHA-256 of the DER-encoded presented certificate matches one of the specified values. A hex-encoded SHA-256 of the certificate can be generated with the following command: .. code-block:: bash $ openssl x509 -in path/to/client.crt -outform DER | openssl dgst -sha256 | cut -d" " -f2 df6ff72fe9116521268f6f2dd4966f51df479883fe7037b39f75916ac3049d1a A long hex-encoded and colon-separated SHA-256 (a.k.a. "fingerprint") of the certificate can be generated with the following command: .. code-block:: bash $ openssl x509 -in path/to/client.crt -noout -fingerprint -sha256 | cut -d"=" -f2 DF:6F:F7:2F:E9:11:65:21:26:8F:6F:2D:D4:96:6F:51:DF:47:98:83:FE:70:37:B3:9F:75:91:6A:C3:04:9D:1A Both of those formats are acceptable. When both: :ref:`verify_certificate_hash <envoy_v3_api_field_extensions.transport_sockets.tls.v3.CertificateValidationContext.verify_certificate_hash>` and :ref:`verify_certificate_spki <envoy_v3_api_field_extensions.transport_sockets.tls.v3.CertificateValidationContext.verify_certificate_spki>` are specified, a hash matching value from either of the lists will result in the certificate being accepted.
repeated string verify_certificate_hash = 2 [(.validate.rules) = { ... }- Specified by:
getVerifyCertificateHashCountin interfaceCertificateValidationContextOrBuilder- Returns:
- The count of verifyCertificateHash.
-
getVerifyCertificateHash
public String getVerifyCertificateHash(int index)
An optional list of hex-encoded SHA-256 hashes. If specified, Envoy will verify that the SHA-256 of the DER-encoded presented certificate matches one of the specified values. A hex-encoded SHA-256 of the certificate can be generated with the following command: .. code-block:: bash $ openssl x509 -in path/to/client.crt -outform DER | openssl dgst -sha256 | cut -d" " -f2 df6ff72fe9116521268f6f2dd4966f51df479883fe7037b39f75916ac3049d1a A long hex-encoded and colon-separated SHA-256 (a.k.a. "fingerprint") of the certificate can be generated with the following command: .. code-block:: bash $ openssl x509 -in path/to/client.crt -noout -fingerprint -sha256 | cut -d"=" -f2 DF:6F:F7:2F:E9:11:65:21:26:8F:6F:2D:D4:96:6F:51:DF:47:98:83:FE:70:37:B3:9F:75:91:6A:C3:04:9D:1A Both of those formats are acceptable. When both: :ref:`verify_certificate_hash <envoy_v3_api_field_extensions.transport_sockets.tls.v3.CertificateValidationContext.verify_certificate_hash>` and :ref:`verify_certificate_spki <envoy_v3_api_field_extensions.transport_sockets.tls.v3.CertificateValidationContext.verify_certificate_spki>` are specified, a hash matching value from either of the lists will result in the certificate being accepted.
repeated string verify_certificate_hash = 2 [(.validate.rules) = { ... }- Specified by:
getVerifyCertificateHashin interfaceCertificateValidationContextOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The verifyCertificateHash at the given index.
-
getVerifyCertificateHashBytes
public com.google.protobuf.ByteString getVerifyCertificateHashBytes(int index)
An optional list of hex-encoded SHA-256 hashes. If specified, Envoy will verify that the SHA-256 of the DER-encoded presented certificate matches one of the specified values. A hex-encoded SHA-256 of the certificate can be generated with the following command: .. code-block:: bash $ openssl x509 -in path/to/client.crt -outform DER | openssl dgst -sha256 | cut -d" " -f2 df6ff72fe9116521268f6f2dd4966f51df479883fe7037b39f75916ac3049d1a A long hex-encoded and colon-separated SHA-256 (a.k.a. "fingerprint") of the certificate can be generated with the following command: .. code-block:: bash $ openssl x509 -in path/to/client.crt -noout -fingerprint -sha256 | cut -d"=" -f2 DF:6F:F7:2F:E9:11:65:21:26:8F:6F:2D:D4:96:6F:51:DF:47:98:83:FE:70:37:B3:9F:75:91:6A:C3:04:9D:1A Both of those formats are acceptable. When both: :ref:`verify_certificate_hash <envoy_v3_api_field_extensions.transport_sockets.tls.v3.CertificateValidationContext.verify_certificate_hash>` and :ref:`verify_certificate_spki <envoy_v3_api_field_extensions.transport_sockets.tls.v3.CertificateValidationContext.verify_certificate_spki>` are specified, a hash matching value from either of the lists will result in the certificate being accepted.
repeated string verify_certificate_hash = 2 [(.validate.rules) = { ... }- Specified by:
getVerifyCertificateHashBytesin interfaceCertificateValidationContextOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the verifyCertificateHash at the given index.
-
getMatchTypedSubjectAltNamesList
public List<SubjectAltNameMatcher> getMatchTypedSubjectAltNamesList()
An optional list of Subject Alternative name matchers. If specified, Envoy will verify that the Subject Alternative Name of the presented certificate matches one of the specified matchers. The matching uses "any" semantics, that is to say, the SAN is verified if at least one matcher is matched. When a certificate has wildcard DNS SAN entries, to match a specific client, it should be configured with exact match type in the :ref:`string matcher <envoy_v3_api_msg_type.matcher.v3.StringMatcher>`. For example if the certificate has "\*.example.com" as DNS SAN entry, to allow only "api.example.com", it should be configured as shown below. .. code-block:: yaml match_typed_subject_alt_names: - san_type: DNS matcher: exact: "api.example.com" .. attention:: Subject Alternative Names are easily spoofable and verifying only them is insecure, therefore this option must be used together with :ref:`trusted_ca <envoy_v3_api_field_extensions.transport_sockets.tls.v3.CertificateValidationContext.trusted_ca>`.repeated .envoy.extensions.transport_sockets.tls.v3.SubjectAltNameMatcher match_typed_subject_alt_names = 15;- Specified by:
getMatchTypedSubjectAltNamesListin interfaceCertificateValidationContextOrBuilder
-
getMatchTypedSubjectAltNamesOrBuilderList
public List<? extends SubjectAltNameMatcherOrBuilder> getMatchTypedSubjectAltNamesOrBuilderList()
An optional list of Subject Alternative name matchers. If specified, Envoy will verify that the Subject Alternative Name of the presented certificate matches one of the specified matchers. The matching uses "any" semantics, that is to say, the SAN is verified if at least one matcher is matched. When a certificate has wildcard DNS SAN entries, to match a specific client, it should be configured with exact match type in the :ref:`string matcher <envoy_v3_api_msg_type.matcher.v3.StringMatcher>`. For example if the certificate has "\*.example.com" as DNS SAN entry, to allow only "api.example.com", it should be configured as shown below. .. code-block:: yaml match_typed_subject_alt_names: - san_type: DNS matcher: exact: "api.example.com" .. attention:: Subject Alternative Names are easily spoofable and verifying only them is insecure, therefore this option must be used together with :ref:`trusted_ca <envoy_v3_api_field_extensions.transport_sockets.tls.v3.CertificateValidationContext.trusted_ca>`.repeated .envoy.extensions.transport_sockets.tls.v3.SubjectAltNameMatcher match_typed_subject_alt_names = 15;- Specified by:
getMatchTypedSubjectAltNamesOrBuilderListin interfaceCertificateValidationContextOrBuilder
-
getMatchTypedSubjectAltNamesCount
public int getMatchTypedSubjectAltNamesCount()
An optional list of Subject Alternative name matchers. If specified, Envoy will verify that the Subject Alternative Name of the presented certificate matches one of the specified matchers. The matching uses "any" semantics, that is to say, the SAN is verified if at least one matcher is matched. When a certificate has wildcard DNS SAN entries, to match a specific client, it should be configured with exact match type in the :ref:`string matcher <envoy_v3_api_msg_type.matcher.v3.StringMatcher>`. For example if the certificate has "\*.example.com" as DNS SAN entry, to allow only "api.example.com", it should be configured as shown below. .. code-block:: yaml match_typed_subject_alt_names: - san_type: DNS matcher: exact: "api.example.com" .. attention:: Subject Alternative Names are easily spoofable and verifying only them is insecure, therefore this option must be used together with :ref:`trusted_ca <envoy_v3_api_field_extensions.transport_sockets.tls.v3.CertificateValidationContext.trusted_ca>`.repeated .envoy.extensions.transport_sockets.tls.v3.SubjectAltNameMatcher match_typed_subject_alt_names = 15;- Specified by:
getMatchTypedSubjectAltNamesCountin interfaceCertificateValidationContextOrBuilder
-
getMatchTypedSubjectAltNames
public SubjectAltNameMatcher getMatchTypedSubjectAltNames(int index)
An optional list of Subject Alternative name matchers. If specified, Envoy will verify that the Subject Alternative Name of the presented certificate matches one of the specified matchers. The matching uses "any" semantics, that is to say, the SAN is verified if at least one matcher is matched. When a certificate has wildcard DNS SAN entries, to match a specific client, it should be configured with exact match type in the :ref:`string matcher <envoy_v3_api_msg_type.matcher.v3.StringMatcher>`. For example if the certificate has "\*.example.com" as DNS SAN entry, to allow only "api.example.com", it should be configured as shown below. .. code-block:: yaml match_typed_subject_alt_names: - san_type: DNS matcher: exact: "api.example.com" .. attention:: Subject Alternative Names are easily spoofable and verifying only them is insecure, therefore this option must be used together with :ref:`trusted_ca <envoy_v3_api_field_extensions.transport_sockets.tls.v3.CertificateValidationContext.trusted_ca>`.repeated .envoy.extensions.transport_sockets.tls.v3.SubjectAltNameMatcher match_typed_subject_alt_names = 15;- Specified by:
getMatchTypedSubjectAltNamesin interfaceCertificateValidationContextOrBuilder
-
getMatchTypedSubjectAltNamesOrBuilder
public SubjectAltNameMatcherOrBuilder getMatchTypedSubjectAltNamesOrBuilder(int index)
An optional list of Subject Alternative name matchers. If specified, Envoy will verify that the Subject Alternative Name of the presented certificate matches one of the specified matchers. The matching uses "any" semantics, that is to say, the SAN is verified if at least one matcher is matched. When a certificate has wildcard DNS SAN entries, to match a specific client, it should be configured with exact match type in the :ref:`string matcher <envoy_v3_api_msg_type.matcher.v3.StringMatcher>`. For example if the certificate has "\*.example.com" as DNS SAN entry, to allow only "api.example.com", it should be configured as shown below. .. code-block:: yaml match_typed_subject_alt_names: - san_type: DNS matcher: exact: "api.example.com" .. attention:: Subject Alternative Names are easily spoofable and verifying only them is insecure, therefore this option must be used together with :ref:`trusted_ca <envoy_v3_api_field_extensions.transport_sockets.tls.v3.CertificateValidationContext.trusted_ca>`.repeated .envoy.extensions.transport_sockets.tls.v3.SubjectAltNameMatcher match_typed_subject_alt_names = 15;- Specified by:
getMatchTypedSubjectAltNamesOrBuilderin interfaceCertificateValidationContextOrBuilder
-
getMatchSubjectAltNamesList
@Deprecated public List<StringMatcher> getMatchSubjectAltNamesList()
Deprecated.This field is deprecated in favor of :ref:`match_typed_subject_alt_names <envoy_v3_api_field_extensions.transport_sockets.tls.v3.CertificateValidationContext.match_typed_subject_alt_names>`. Note that if both this field and :ref:`match_typed_subject_alt_names <envoy_v3_api_field_extensions.transport_sockets.tls.v3.CertificateValidationContext.match_typed_subject_alt_names>` are specified, the former (deprecated field) is ignored.
repeated .envoy.type.matcher.v3.StringMatcher match_subject_alt_names = 9 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];- Specified by:
getMatchSubjectAltNamesListin interfaceCertificateValidationContextOrBuilder
-
getMatchSubjectAltNamesOrBuilderList
@Deprecated public List<? extends StringMatcherOrBuilder> getMatchSubjectAltNamesOrBuilderList()
Deprecated.This field is deprecated in favor of :ref:`match_typed_subject_alt_names <envoy_v3_api_field_extensions.transport_sockets.tls.v3.CertificateValidationContext.match_typed_subject_alt_names>`. Note that if both this field and :ref:`match_typed_subject_alt_names <envoy_v3_api_field_extensions.transport_sockets.tls.v3.CertificateValidationContext.match_typed_subject_alt_names>` are specified, the former (deprecated field) is ignored.
repeated .envoy.type.matcher.v3.StringMatcher match_subject_alt_names = 9 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];- Specified by:
getMatchSubjectAltNamesOrBuilderListin interfaceCertificateValidationContextOrBuilder
-
getMatchSubjectAltNamesCount
@Deprecated public int getMatchSubjectAltNamesCount()
Deprecated.This field is deprecated in favor of :ref:`match_typed_subject_alt_names <envoy_v3_api_field_extensions.transport_sockets.tls.v3.CertificateValidationContext.match_typed_subject_alt_names>`. Note that if both this field and :ref:`match_typed_subject_alt_names <envoy_v3_api_field_extensions.transport_sockets.tls.v3.CertificateValidationContext.match_typed_subject_alt_names>` are specified, the former (deprecated field) is ignored.
repeated .envoy.type.matcher.v3.StringMatcher match_subject_alt_names = 9 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];- Specified by:
getMatchSubjectAltNamesCountin interfaceCertificateValidationContextOrBuilder
-
getMatchSubjectAltNames
@Deprecated public StringMatcher getMatchSubjectAltNames(int index)
Deprecated.This field is deprecated in favor of :ref:`match_typed_subject_alt_names <envoy_v3_api_field_extensions.transport_sockets.tls.v3.CertificateValidationContext.match_typed_subject_alt_names>`. Note that if both this field and :ref:`match_typed_subject_alt_names <envoy_v3_api_field_extensions.transport_sockets.tls.v3.CertificateValidationContext.match_typed_subject_alt_names>` are specified, the former (deprecated field) is ignored.
repeated .envoy.type.matcher.v3.StringMatcher match_subject_alt_names = 9 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];- Specified by:
getMatchSubjectAltNamesin interfaceCertificateValidationContextOrBuilder
-
getMatchSubjectAltNamesOrBuilder
@Deprecated public StringMatcherOrBuilder getMatchSubjectAltNamesOrBuilder(int index)
Deprecated.This field is deprecated in favor of :ref:`match_typed_subject_alt_names <envoy_v3_api_field_extensions.transport_sockets.tls.v3.CertificateValidationContext.match_typed_subject_alt_names>`. Note that if both this field and :ref:`match_typed_subject_alt_names <envoy_v3_api_field_extensions.transport_sockets.tls.v3.CertificateValidationContext.match_typed_subject_alt_names>` are specified, the former (deprecated field) is ignored.
repeated .envoy.type.matcher.v3.StringMatcher match_subject_alt_names = 9 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];- Specified by:
getMatchSubjectAltNamesOrBuilderin interfaceCertificateValidationContextOrBuilder
-
hasRequireSignedCertificateTimestamp
public boolean hasRequireSignedCertificateTimestamp()
[#not-implemented-hide:] Must present signed certificate time-stamp.
.google.protobuf.BoolValue require_signed_certificate_timestamp = 6;- Specified by:
hasRequireSignedCertificateTimestampin interfaceCertificateValidationContextOrBuilder- Returns:
- Whether the requireSignedCertificateTimestamp field is set.
-
getRequireSignedCertificateTimestamp
public com.google.protobuf.BoolValue getRequireSignedCertificateTimestamp()
[#not-implemented-hide:] Must present signed certificate time-stamp.
.google.protobuf.BoolValue require_signed_certificate_timestamp = 6;- Specified by:
getRequireSignedCertificateTimestampin interfaceCertificateValidationContextOrBuilder- Returns:
- The requireSignedCertificateTimestamp.
-
getRequireSignedCertificateTimestampOrBuilder
public com.google.protobuf.BoolValueOrBuilder getRequireSignedCertificateTimestampOrBuilder()
[#not-implemented-hide:] Must present signed certificate time-stamp.
.google.protobuf.BoolValue require_signed_certificate_timestamp = 6;- Specified by:
getRequireSignedCertificateTimestampOrBuilderin interfaceCertificateValidationContextOrBuilder
-
hasCrl
public boolean hasCrl()
An optional `certificate revocation list <https://en.wikipedia.org/wiki/Certificate_revocation_list>`_ (in PEM format). If specified, Envoy will verify that the presented peer certificate has not been revoked by this CRL. If this DataSource contains multiple CRLs, all of them will be used. Note that if a CRL is provided for any certificate authority in a trust chain, a CRL must be provided for all certificate authorities in that chain. Failure to do so will result in verification failure for both revoked and unrevoked certificates from that chain. This default behavior can be altered by setting :ref:`only_verify_leaf_cert_crl <envoy_v3_api_field_extensions.transport_sockets.tls.v3.CertificateValidationContext.only_verify_leaf_cert_crl>` to true.
.envoy.config.core.v3.DataSource crl = 7;- Specified by:
hasCrlin interfaceCertificateValidationContextOrBuilder- Returns:
- Whether the crl field is set.
-
getCrl
public DataSource getCrl()
An optional `certificate revocation list <https://en.wikipedia.org/wiki/Certificate_revocation_list>`_ (in PEM format). If specified, Envoy will verify that the presented peer certificate has not been revoked by this CRL. If this DataSource contains multiple CRLs, all of them will be used. Note that if a CRL is provided for any certificate authority in a trust chain, a CRL must be provided for all certificate authorities in that chain. Failure to do so will result in verification failure for both revoked and unrevoked certificates from that chain. This default behavior can be altered by setting :ref:`only_verify_leaf_cert_crl <envoy_v3_api_field_extensions.transport_sockets.tls.v3.CertificateValidationContext.only_verify_leaf_cert_crl>` to true.
.envoy.config.core.v3.DataSource crl = 7;- Specified by:
getCrlin interfaceCertificateValidationContextOrBuilder- Returns:
- The crl.
-
getCrlOrBuilder
public DataSourceOrBuilder getCrlOrBuilder()
An optional `certificate revocation list <https://en.wikipedia.org/wiki/Certificate_revocation_list>`_ (in PEM format). If specified, Envoy will verify that the presented peer certificate has not been revoked by this CRL. If this DataSource contains multiple CRLs, all of them will be used. Note that if a CRL is provided for any certificate authority in a trust chain, a CRL must be provided for all certificate authorities in that chain. Failure to do so will result in verification failure for both revoked and unrevoked certificates from that chain. This default behavior can be altered by setting :ref:`only_verify_leaf_cert_crl <envoy_v3_api_field_extensions.transport_sockets.tls.v3.CertificateValidationContext.only_verify_leaf_cert_crl>` to true.
.envoy.config.core.v3.DataSource crl = 7;- Specified by:
getCrlOrBuilderin interfaceCertificateValidationContextOrBuilder
-
getAllowExpiredCertificate
public boolean getAllowExpiredCertificate()
If specified, Envoy will not reject expired certificates.
bool allow_expired_certificate = 8;- Specified by:
getAllowExpiredCertificatein interfaceCertificateValidationContextOrBuilder- Returns:
- The allowExpiredCertificate.
-
getTrustChainVerificationValue
public int getTrustChainVerificationValue()
Certificate trust chain verification mode.
.envoy.extensions.transport_sockets.tls.v3.CertificateValidationContext.TrustChainVerification trust_chain_verification = 10 [(.validate.rules) = { ... }- Specified by:
getTrustChainVerificationValuein interfaceCertificateValidationContextOrBuilder- Returns:
- The enum numeric value on the wire for trustChainVerification.
-
getTrustChainVerification
public CertificateValidationContext.TrustChainVerification getTrustChainVerification()
Certificate trust chain verification mode.
.envoy.extensions.transport_sockets.tls.v3.CertificateValidationContext.TrustChainVerification trust_chain_verification = 10 [(.validate.rules) = { ... }- Specified by:
getTrustChainVerificationin interfaceCertificateValidationContextOrBuilder- Returns:
- The trustChainVerification.
-
hasCustomValidatorConfig
public boolean hasCustomValidatorConfig()
The configuration of an extension specific certificate validator. If specified, all validation is done by the specified validator, and the behavior of all other validation settings is defined by the specified validator (and may be entirely ignored, unused, and unvalidated). Refer to the documentation for the specified validator. If you do not want a custom validation algorithm, do not set this field. [#extension-category: envoy.tls.cert_validator]
.envoy.config.core.v3.TypedExtensionConfig custom_validator_config = 12;- Specified by:
hasCustomValidatorConfigin interfaceCertificateValidationContextOrBuilder- Returns:
- Whether the customValidatorConfig field is set.
-
getCustomValidatorConfig
public TypedExtensionConfig getCustomValidatorConfig()
The configuration of an extension specific certificate validator. If specified, all validation is done by the specified validator, and the behavior of all other validation settings is defined by the specified validator (and may be entirely ignored, unused, and unvalidated). Refer to the documentation for the specified validator. If you do not want a custom validation algorithm, do not set this field. [#extension-category: envoy.tls.cert_validator]
.envoy.config.core.v3.TypedExtensionConfig custom_validator_config = 12;- Specified by:
getCustomValidatorConfigin interfaceCertificateValidationContextOrBuilder- Returns:
- The customValidatorConfig.
-
getCustomValidatorConfigOrBuilder
public TypedExtensionConfigOrBuilder getCustomValidatorConfigOrBuilder()
The configuration of an extension specific certificate validator. If specified, all validation is done by the specified validator, and the behavior of all other validation settings is defined by the specified validator (and may be entirely ignored, unused, and unvalidated). Refer to the documentation for the specified validator. If you do not want a custom validation algorithm, do not set this field. [#extension-category: envoy.tls.cert_validator]
.envoy.config.core.v3.TypedExtensionConfig custom_validator_config = 12;- Specified by:
getCustomValidatorConfigOrBuilderin interfaceCertificateValidationContextOrBuilder
-
getOnlyVerifyLeafCertCrl
public boolean getOnlyVerifyLeafCertCrl()
If this option is set to true, only the certificate at the end of the certificate chain will be subject to validation by :ref:`CRL <envoy_v3_api_field_extensions.transport_sockets.tls.v3.CertificateValidationContext.crl>`.
bool only_verify_leaf_cert_crl = 14;- Specified by:
getOnlyVerifyLeafCertCrlin interfaceCertificateValidationContextOrBuilder- Returns:
- The onlyVerifyLeafCertCrl.
-
hasMaxVerifyDepth
public boolean hasMaxVerifyDepth()
Config for the max number of intermediate certificates in chain that are parsed during verification. This does not include the leaf certificate. If configured, and the certificate chain is longer than allowed, the certificates above the limit are ignored, and certificate validation will fail. The default limit is 100, though this can be system-dependent. https://www.openssl.org/docs/man1.1.1/man3/SSL_CTX_set_verify_depth.html
.google.protobuf.UInt32Value max_verify_depth = 16 [(.validate.rules) = { ... }- Specified by:
hasMaxVerifyDepthin interfaceCertificateValidationContextOrBuilder- Returns:
- Whether the maxVerifyDepth field is set.
-
getMaxVerifyDepth
public com.google.protobuf.UInt32Value getMaxVerifyDepth()
Config for the max number of intermediate certificates in chain that are parsed during verification. This does not include the leaf certificate. If configured, and the certificate chain is longer than allowed, the certificates above the limit are ignored, and certificate validation will fail. The default limit is 100, though this can be system-dependent. https://www.openssl.org/docs/man1.1.1/man3/SSL_CTX_set_verify_depth.html
.google.protobuf.UInt32Value max_verify_depth = 16 [(.validate.rules) = { ... }- Specified by:
getMaxVerifyDepthin interfaceCertificateValidationContextOrBuilder- Returns:
- The maxVerifyDepth.
-
getMaxVerifyDepthOrBuilder
public com.google.protobuf.UInt32ValueOrBuilder getMaxVerifyDepthOrBuilder()
Config for the max number of intermediate certificates in chain that are parsed during verification. This does not include the leaf certificate. If configured, and the certificate chain is longer than allowed, the certificates above the limit are ignored, and certificate validation will fail. The default limit is 100, though this can be system-dependent. https://www.openssl.org/docs/man1.1.1/man3/SSL_CTX_set_verify_depth.html
.google.protobuf.UInt32Value max_verify_depth = 16 [(.validate.rules) = { ... }- Specified by:
getMaxVerifyDepthOrBuilderin interfaceCertificateValidationContextOrBuilder
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3
-
writeTo
public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException- 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
public boolean equals(Object obj)
- 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 CertificateValidationContext parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static CertificateValidationContext parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static CertificateValidationContext parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static CertificateValidationContext parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static CertificateValidationContext parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static CertificateValidationContext parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static CertificateValidationContext parseFrom(InputStream input) throws IOException
- Throws:
IOException
-
parseFrom
public static CertificateValidationContext parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
parseDelimitedFrom
public static CertificateValidationContext parseDelimitedFrom(InputStream input) throws IOException
- Throws:
IOException
-
parseDelimitedFrom
public static CertificateValidationContext parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
parseFrom
public static CertificateValidationContext parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
- Throws:
IOException
-
parseFrom
public static CertificateValidationContext parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
newBuilderForType
public CertificateValidationContext.Builder newBuilderForType()
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
public static CertificateValidationContext.Builder newBuilder()
-
newBuilder
public static CertificateValidationContext.Builder newBuilder(CertificateValidationContext prototype)
-
toBuilder
public CertificateValidationContext.Builder toBuilder()
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected CertificateValidationContext.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
- Specified by:
newBuilderForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
public static CertificateValidationContext getDefaultInstance()
-
parser
public static com.google.protobuf.Parser<CertificateValidationContext> parser()
-
getParserForType
public com.google.protobuf.Parser<CertificateValidationContext> getParserForType()
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
public CertificateValidationContext getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
-