envoy.config.filter.http.ext_authz.v2alpha

Class ExtAuthzOuterClass.HttpService

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

envoy.config.filter.http.ext_authz.v2alpha.ExtAuthzOuterClass.HttpService

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ExtAuthzOuterClass.HttpServiceOrBuilder, Serializable

Enclosing class:

ExtAuthzOuterClass

public static final class ExtAuthzOuterClass.HttpService
extends com.google.protobuf.GeneratedMessageV3
implements ExtAuthzOuterClass.HttpServiceOrBuilder

 External Authorization filter calls out to an upstream authorization server by passing the raw
 HTTP request headers to the server. This allows the authorization service to take a decision
 whether the request is authorized or not.
 A successful check allows the authorization service adding or overriding headers from the
 original request before dispatching it to the upstream. This is done by including the headers in
 the response sent back from the authorization service to the filter. Note that `Status`,
 `Method`, `Path` and `Content Length` response headers are automatically removed from this
 response by the filter. If other headers need be deleted, they should be specified in
 `response_headers_to_remove` field.
 A failed check will cause this filter to close the HTTP request normally with 403 (Forbidden),
 unless a different status code has been indicated by the authorization service via response
 headers. The HTTP service also allows the authorization filter to also pass data from the
 response body to the downstream client in case of a denied request.
 

Protobuf type envoy.config.filter.http.ext_authz.v2alpha.HttpService

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExtAuthzOuterClass.HttpService.Builder External Authorization filter calls out to an upstream authorization server by passing the raw HTTP request headers to the server.

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

Field Summary

Fields

Modifier and Type	Field and Description
static int	PATH_PREFIX_FIELD_NUMBER
static int	RESPONSE_HEADERS_TO_REMOVE_FIELD_NUMBER
static int	SERVER_URI_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 ExtAuthzOuterClass.HttpService	getDefaultInstance()
ExtAuthzOuterClass.HttpService	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Parser<ExtAuthzOuterClass.HttpService>	getParserForType()
String	getPathPrefix() Sets an optional prefix to the value of authorization request header `path`.
com.google.protobuf.ByteString	getPathPrefixBytes() Sets an optional prefix to the value of authorization request header `path`.
String	getResponseHeadersToRemove(int index) Sets a list of headers that should be not be sent *from the authorization server* to the upstream.
com.google.protobuf.ByteString	getResponseHeadersToRemoveBytes(int index) Sets a list of headers that should be not be sent *from the authorization server* to the upstream.
int	getResponseHeadersToRemoveCount() Sets a list of headers that should be not be sent *from the authorization server* to the upstream.
com.google.protobuf.ProtocolStringList	getResponseHeadersToRemoveList() Sets a list of headers that should be not be sent *from the authorization server* to the upstream.
int	getSerializedSize()
HttpUriOuterClass.HttpUri	getServerUri() Sets the HTTP server URI which the authorization requests must be sent to.
HttpUriOuterClass.HttpUriOrBuilder	getServerUriOrBuilder() Sets the HTTP server URI which the authorization requests must be sent to.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
boolean	hasServerUri() Sets the HTTP server URI which the authorization requests must be sent to.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static ExtAuthzOuterClass.HttpService.Builder	newBuilder()
static ExtAuthzOuterClass.HttpService.Builder	newBuilder(ExtAuthzOuterClass.HttpService prototype)
ExtAuthzOuterClass.HttpService.Builder	newBuilderForType()
protected ExtAuthzOuterClass.HttpService.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
static ExtAuthzOuterClass.HttpService	parseDelimitedFrom(InputStream input)
static ExtAuthzOuterClass.HttpService	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ExtAuthzOuterClass.HttpService	parseFrom(byte[] data)
static ExtAuthzOuterClass.HttpService	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ExtAuthzOuterClass.HttpService	parseFrom(ByteBuffer data)
static ExtAuthzOuterClass.HttpService	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ExtAuthzOuterClass.HttpService	parseFrom(com.google.protobuf.ByteString data)
static ExtAuthzOuterClass.HttpService	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ExtAuthzOuterClass.HttpService	parseFrom(com.google.protobuf.CodedInputStream input)
static ExtAuthzOuterClass.HttpService	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ExtAuthzOuterClass.HttpService	parseFrom(InputStream input)
static ExtAuthzOuterClass.HttpService	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<ExtAuthzOuterClass.HttpService>	parser()
ExtAuthzOuterClass.HttpService.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, newBuilderForType, 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

SERVER_URI_FIELD_NUMBER

public static final int SERVER_URI_FIELD_NUMBER

See Also:

Constant Field Values

PATH_PREFIX_FIELD_NUMBER

public static final int PATH_PREFIX_FIELD_NUMBER

See Also:

Constant Field Values

RESPONSE_HEADERS_TO_REMOVE_FIELD_NUMBER

public static final int RESPONSE_HEADERS_TO_REMOVE_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

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

hasServerUri

public boolean hasServerUri()

 Sets the HTTP server URI which the authorization requests must be sent to.
 

.envoy.api.v2.core.HttpUri server_uri = 1;

Specified by:

hasServerUri in interface ExtAuthzOuterClass.HttpServiceOrBuilder

getServerUri

public HttpUriOuterClass.HttpUri getServerUri()

 Sets the HTTP server URI which the authorization requests must be sent to.
 

.envoy.api.v2.core.HttpUri server_uri = 1;

Specified by:

getServerUri in interface ExtAuthzOuterClass.HttpServiceOrBuilder

getServerUriOrBuilder

public HttpUriOuterClass.HttpUriOrBuilder getServerUriOrBuilder()

 Sets the HTTP server URI which the authorization requests must be sent to.
 

.envoy.api.v2.core.HttpUri server_uri = 1;

Specified by:

getServerUriOrBuilder in interface ExtAuthzOuterClass.HttpServiceOrBuilder

getPathPrefix

public String getPathPrefix()

 Sets an optional prefix to the value of authorization request header `path`.
 

string path_prefix = 2;

Specified by:

getPathPrefix in interface ExtAuthzOuterClass.HttpServiceOrBuilder

getPathPrefixBytes

public com.google.protobuf.ByteString getPathPrefixBytes()

 Sets an optional prefix to the value of authorization request header `path`.
 

string path_prefix = 2;

Specified by:

getPathPrefixBytes in interface ExtAuthzOuterClass.HttpServiceOrBuilder

getResponseHeadersToRemoveList

public com.google.protobuf.ProtocolStringList getResponseHeadersToRemoveList()

 Sets a list of headers that should be not be sent *from the authorization server* to the
 upstream.
 

repeated string response_headers_to_remove = 3;

Specified by:

getResponseHeadersToRemoveList in interface ExtAuthzOuterClass.HttpServiceOrBuilder

getResponseHeadersToRemoveCount

public int getResponseHeadersToRemoveCount()

 Sets a list of headers that should be not be sent *from the authorization server* to the
 upstream.
 

repeated string response_headers_to_remove = 3;

Specified by:

getResponseHeadersToRemoveCount in interface ExtAuthzOuterClass.HttpServiceOrBuilder

getResponseHeadersToRemove

public String getResponseHeadersToRemove(int index)

 Sets a list of headers that should be not be sent *from the authorization server* to the
 upstream.
 

repeated string response_headers_to_remove = 3;

Specified by:

getResponseHeadersToRemove in interface ExtAuthzOuterClass.HttpServiceOrBuilder

getResponseHeadersToRemoveBytes

public com.google.protobuf.ByteString getResponseHeadersToRemoveBytes(int index)

 Sets a list of headers that should be not be sent *from the authorization server* to the
 upstream.
 

repeated string response_headers_to_remove = 3;

Specified by:

getResponseHeadersToRemoveBytes in interface ExtAuthzOuterClass.HttpServiceOrBuilder

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ExtAuthzOuterClass.HttpService parseFrom(InputStream input)
                                                throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static ExtAuthzOuterClass.HttpService parseDelimitedFrom(InputStream input)
                                                         throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public ExtAuthzOuterClass.HttpService.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static ExtAuthzOuterClass.HttpService.Builder newBuilder()

newBuilder

public static ExtAuthzOuterClass.HttpService.Builder newBuilder(ExtAuthzOuterClass.HttpService prototype)

toBuilder

public ExtAuthzOuterClass.HttpService.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static ExtAuthzOuterClass.HttpService getDefaultInstance()

parser

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

getParserForType

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

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder