Package io.envoyproxy.envoy.extensions.filters.network.redis_proxy.v3

Class RedisExternalAuthProvider

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.filters.network.redis_proxy.v3.RedisExternalAuthProvider
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RedisExternalAuthProviderOrBuilder, Serializable
public final class RedisExternalAuthProvider extends com.google.protobuf.GeneratedMessageV3 implements RedisExternalAuthProviderOrBuilder
 RedisExternalAuthProvider specifies a gRPC service that can be used to authenticate Redis clients.
 This service will be called every time an AUTH command is received from a client.
 If the service returns an error, authentication is considered failed.
 If the service returns a success, the client is considered authenticated.
 The service can also return an expiration timestamp, which will be used to disable any further
 commands from the client after it passes, unless a new AUTH command is received and the
 external auth service returns a new expiration timestamp.
Protobuf type envoy.extensions.filters.network.redis_proxy.v3.RedisExternalAuthProvider
See Also:

  • Field Details

    • GRPC_SERVICE_FIELD_NUMBER

      public static final int GRPC_SERVICE_FIELD_NUMBER
      See Also:

    • ENABLE_AUTH_EXPIRATION_FIELD_NUMBER

      public static final int ENABLE_AUTH_EXPIRATION_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

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

    • internalGetFieldAccessorTable

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

    • hasGrpcService

      public boolean hasGrpcService()
       External auth gRPC service configuration.
 It will be called every time an AUTH command is received from a client.
      .envoy.config.core.v3.GrpcService grpc_service = 1;
      Specified by:
      hasGrpcService in interface RedisExternalAuthProviderOrBuilder
      Returns:
      Whether the grpcService field is set.

    • getGrpcService

      public GrpcService getGrpcService()
       External auth gRPC service configuration.
 It will be called every time an AUTH command is received from a client.
      .envoy.config.core.v3.GrpcService grpc_service = 1;
      Specified by:
      getGrpcService in interface RedisExternalAuthProviderOrBuilder
      Returns:
      The grpcService.

    • getGrpcServiceOrBuilder

      public GrpcServiceOrBuilder getGrpcServiceOrBuilder()
       External auth gRPC service configuration.
 It will be called every time an AUTH command is received from a client.
      .envoy.config.core.v3.GrpcService grpc_service = 1;
      Specified by:
      getGrpcServiceOrBuilder in interface RedisExternalAuthProviderOrBuilder

    • getEnableAuthExpiration

      public boolean getEnableAuthExpiration()
       If set to true, the filter will expect an expiration timestamp in the response from the external
 auth service. This timestamp will be used to disable any further commands from the client after
 the expiration time, unless a new AUTH command is received and the external auth service returns
 a new expiration timestamp.
      bool enable_auth_expiration = 2;
      Specified by:
      getEnableAuthExpiration in interface RedisExternalAuthProviderOrBuilder
      Returns:
      The enableAuthExpiration.

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static RedisExternalAuthProvider.Builder newBuilder()

    • newBuilder

      public static RedisExternalAuthProvider.Builder newBuilder(RedisExternalAuthProvider prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static RedisExternalAuthProvider getDefaultInstance()

    • parser

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

    • getParserForType

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