io.envoyproxy.envoy.extensions.filters.network.ext_authz.v4alpha

Class ExtAuthz

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

io.envoyproxy.envoy.extensions.filters.network.ext_authz.v4alpha.ExtAuthz

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ExtAuthzOrBuilder, Serializable

public final class ExtAuthz
extends com.google.protobuf.GeneratedMessageV3
implements ExtAuthzOrBuilder

 External Authorization filter calls out to an external service over the
 gRPC Authorization API defined by
 :ref:`CheckRequest <envoy_api_msg_service.auth.v4alpha.CheckRequest>`.
 A failed check will cause this filter to close the TCP connection.
 [#next-free-field: 7]
 

Protobuf type envoy.extensions.filters.network.ext_authz.v4alpha.ExtAuthz

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExtAuthz.Builder External Authorization filter calls out to an external service over the gRPC Authorization API defined by :ref:`CheckRequest <envoy_api_msg_service.auth.v4alpha.CheckRequest>`.

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 and Description
static int	FAILURE_MODE_ALLOW_FIELD_NUMBER
static int	FILTER_ENABLED_METADATA_FIELD_NUMBER
static int	GRPC_SERVICE_FIELD_NUMBER
static int	INCLUDE_PEER_CERTIFICATE_FIELD_NUMBER
static int	STAT_PREFIX_FIELD_NUMBER
static int	TRANSPORT_API_VERSION_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static ExtAuthz	getDefaultInstance()
ExtAuthz	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
boolean	getFailureModeAllow() The filter's behaviour in case the external authorization service does not respond back.
MetadataMatcher	getFilterEnabledMetadata() Specifies if the filter is enabled with metadata matcher.
MetadataMatcherOrBuilder	getFilterEnabledMetadataOrBuilder() Specifies if the filter is enabled with metadata matcher.
GrpcService	getGrpcService() The external authorization gRPC service configuration.
GrpcServiceOrBuilder	getGrpcServiceOrBuilder() The external authorization gRPC service configuration.
boolean	getIncludePeerCertificate() Specifies if the peer certificate is sent to the external service.
com.google.protobuf.Parser<ExtAuthz>	getParserForType()
int	getSerializedSize()
String	getStatPrefix() The prefix to use when emitting statistics.
com.google.protobuf.ByteString	getStatPrefixBytes() The prefix to use when emitting statistics.
ApiVersion	getTransportApiVersion() API version for ext_authz transport protocol.
int	getTransportApiVersionValue() API version for ext_authz transport protocol.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
boolean	hasFilterEnabledMetadata() Specifies if the filter is enabled with metadata matcher.
boolean	hasGrpcService() The external authorization gRPC service configuration.
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static ExtAuthz.Builder	newBuilder()
static ExtAuthz.Builder	newBuilder(ExtAuthz prototype)
ExtAuthz.Builder	newBuilderForType()
protected ExtAuthz.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static ExtAuthz	parseDelimitedFrom(InputStream input)
static ExtAuthz	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ExtAuthz	parseFrom(byte[] data)
static ExtAuthz	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ExtAuthz	parseFrom(ByteBuffer data)
static ExtAuthz	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ExtAuthz	parseFrom(com.google.protobuf.ByteString data)
static ExtAuthz	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ExtAuthz	parseFrom(com.google.protobuf.CodedInputStream input)
static ExtAuthz	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ExtAuthz	parseFrom(InputStream input)
static ExtAuthz	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<ExtAuthz>	parser()
ExtAuthz.Builder	toBuilder()
void	writeTo(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, 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

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

STAT_PREFIX_FIELD_NUMBER

public static final int STAT_PREFIX_FIELD_NUMBER

See Also:

Constant Field Values

GRPC_SERVICE_FIELD_NUMBER

public static final int GRPC_SERVICE_FIELD_NUMBER

See Also:

Constant Field Values

FAILURE_MODE_ALLOW_FIELD_NUMBER

public static final int FAILURE_MODE_ALLOW_FIELD_NUMBER

See Also:

Constant Field Values

INCLUDE_PEER_CERTIFICATE_FIELD_NUMBER

public static final int INCLUDE_PEER_CERTIFICATE_FIELD_NUMBER

See Also:

Constant Field Values

TRANSPORT_API_VERSION_FIELD_NUMBER

public static final int TRANSPORT_API_VERSION_FIELD_NUMBER

See Also:

Constant Field Values

FILTER_ENABLED_METADATA_FIELD_NUMBER

public static final int FILTER_ENABLED_METADATA_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields 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

getStatPrefix

public String getStatPrefix()

 The prefix to use when emitting statistics.
 

string stat_prefix = 1 [(.validate.rules) = { ... }

Specified by:

getStatPrefix in interface ExtAuthzOrBuilder

getStatPrefixBytes

public com.google.protobuf.ByteString getStatPrefixBytes()

 The prefix to use when emitting statistics.
 

string stat_prefix = 1 [(.validate.rules) = { ... }

Specified by:

getStatPrefixBytes in interface ExtAuthzOrBuilder

hasGrpcService

public boolean hasGrpcService()

 The external authorization gRPC service configuration.
 The default timeout is set to 200ms by this filter.
 

.envoy.config.core.v4alpha.GrpcService grpc_service = 2;

Specified by:

hasGrpcService in interface ExtAuthzOrBuilder

getGrpcService

public GrpcService getGrpcService()

 The external authorization gRPC service configuration.
 The default timeout is set to 200ms by this filter.
 

.envoy.config.core.v4alpha.GrpcService grpc_service = 2;

Specified by:

getGrpcService in interface ExtAuthzOrBuilder

getGrpcServiceOrBuilder

public GrpcServiceOrBuilder getGrpcServiceOrBuilder()

 The external authorization gRPC service configuration.
 The default timeout is set to 200ms by this filter.
 

.envoy.config.core.v4alpha.GrpcService grpc_service = 2;

Specified by:

getGrpcServiceOrBuilder in interface ExtAuthzOrBuilder

getFailureModeAllow

public boolean getFailureModeAllow()

 The filter's behaviour in case the external authorization service does
 not respond back. When it is set to true, Envoy will also allow traffic in case of
 communication failure between authorization service and the proxy.
 Defaults to false.
 

bool failure_mode_allow = 3;

Specified by:

getFailureModeAllow in interface ExtAuthzOrBuilder

getIncludePeerCertificate

public boolean getIncludePeerCertificate()

 Specifies if the peer certificate is sent to the external service.
 When this field is true, Envoy will include the peer X.509 certificate, if available, in the
 :ref:`certificate<envoy_api_field_service.auth.v4alpha.AttributeContext.Peer.certificate>`.
 

bool include_peer_certificate = 4;

Specified by:

getIncludePeerCertificate in interface ExtAuthzOrBuilder

getTransportApiVersionValue

public int getTransportApiVersionValue()

 API version for ext_authz transport protocol. This describes the ext_authz gRPC endpoint and
 version of Check{Request,Response} used on the wire.
 

.envoy.config.core.v4alpha.ApiVersion transport_api_version = 5 [(.validate.rules) = { ... }

Specified by:

getTransportApiVersionValue in interface ExtAuthzOrBuilder

getTransportApiVersion

public ApiVersion getTransportApiVersion()

 API version for ext_authz transport protocol. This describes the ext_authz gRPC endpoint and
 version of Check{Request,Response} used on the wire.
 

.envoy.config.core.v4alpha.ApiVersion transport_api_version = 5 [(.validate.rules) = { ... }

Specified by:

getTransportApiVersion in interface ExtAuthzOrBuilder

hasFilterEnabledMetadata

public boolean hasFilterEnabledMetadata()

 Specifies if the filter is enabled with metadata matcher.
 If this field is not specified, the filter will be enabled for all requests.
 

.envoy.type.matcher.v4alpha.MetadataMatcher filter_enabled_metadata = 6;

Specified by:

hasFilterEnabledMetadata in interface ExtAuthzOrBuilder

getFilterEnabledMetadata

public MetadataMatcher getFilterEnabledMetadata()

 Specifies if the filter is enabled with metadata matcher.
 If this field is not specified, the filter will be enabled for all requests.
 

.envoy.type.matcher.v4alpha.MetadataMatcher filter_enabled_metadata = 6;

Specified by:

getFilterEnabledMetadata in interface ExtAuthzOrBuilder

getFilterEnabledMetadataOrBuilder

public MetadataMatcherOrBuilder getFilterEnabledMetadataOrBuilder()

 Specifies if the filter is enabled with metadata matcher.
 If this field is not specified, the filter will be enabled for all requests.
 

.envoy.type.matcher.v4alpha.MetadataMatcher filter_enabled_metadata = 6;

Specified by:

getFilterEnabledMetadataOrBuilder in interface ExtAuthzOrBuilder

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 ExtAuthz parseFrom(ByteBuffer data)
                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ExtAuthz parseFrom(com.google.protobuf.ByteString data)
                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ExtAuthz parseFrom(byte[] data)
                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ExtAuthz parseFrom(InputStream input)
                          throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static ExtAuthz parseDelimitedFrom(InputStream input)
                                   throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

public static ExtAuthz parseFrom(com.google.protobuf.CodedInputStream input)
                          throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public ExtAuthz.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static ExtAuthz.Builder newBuilder()

newBuilder

public static ExtAuthz.Builder newBuilder(ExtAuthz prototype)

toBuilder

public ExtAuthz.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected ExtAuthz.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static ExtAuthz getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<ExtAuthz> 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 ExtAuthz getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder