Package io.envoyproxy.envoy.extensions.filters.http.api_key_auth.v3

Class ApiKeyAuth

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.filters.http.api_key_auth.v3.ApiKeyAuth
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ApiKeyAuthOrBuilder, Serializable
public final class ApiKeyAuth extends com.google.protobuf.GeneratedMessageV3 implements ApiKeyAuthOrBuilder
 API Key HTTP authentication.

 For example, the following configuration configures the filter to authenticate the clients using
 the API key from the header ``X-API-KEY``. And only the clients with the key ``real-key`` are
 considered as authenticated. The client information is configured to be forwarded
 in the header ``x-client-id``.

 .. code-block:: yaml

    credentials:
    - key: real-key
      client: user
    key_sources:
     - header: "X-API-KEY"
    forwarding:
      header: "x-client-id"
      hide_credentials: false
Protobuf type envoy.extensions.filters.http.api_key_auth.v3.ApiKeyAuth
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    ApiKeyAuth.Builder
    API Key HTTP authentication.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    CREDENTIALS_FIELD_NUMBER
     
    static final int
    FORWARDING_FIELD_NUMBER
     
    static final int
    KEY_SOURCES_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
    Description
    boolean
    equals(Object obj)
     
    Credential
    getCredentials(int index)
    The credentials that are used to authenticate the clients.
    int
    getCredentialsCount()
    The credentials that are used to authenticate the clients.
    List<Credential>
    getCredentialsList()
    The credentials that are used to authenticate the clients.
    CredentialOrBuilder
    getCredentialsOrBuilder(int index)
    The credentials that are used to authenticate the clients.
    List<? extends CredentialOrBuilder>
    getCredentialsOrBuilderList()
    The credentials that are used to authenticate the clients.
    static ApiKeyAuth
    getDefaultInstance()
     
    ApiKeyAuth
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    Forwarding
    getForwarding()
    Optional configuration to control what information should be propagated to upstream services.
    ForwardingOrBuilder
    getForwardingOrBuilder()
    Optional configuration to control what information should be propagated to upstream services.
    KeySource
    getKeySources(int index)
    The key sources to fetch the key from the coming request.
    int
    getKeySourcesCount()
    The key sources to fetch the key from the coming request.
    List<KeySource>
    getKeySourcesList()
    The key sources to fetch the key from the coming request.
    KeySourceOrBuilder
    getKeySourcesOrBuilder(int index)
    The key sources to fetch the key from the coming request.
    List<? extends KeySourceOrBuilder>
    getKeySourcesOrBuilderList()
    The key sources to fetch the key from the coming request.
    com.google.protobuf.Parser<ApiKeyAuth>
    getParserForType()
     
    int
    getSerializedSize()
     
    boolean
    hasForwarding()
    Optional configuration to control what information should be propagated to upstream services.
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static ApiKeyAuth.Builder
    newBuilder()
     
    static ApiKeyAuth.Builder
    newBuilder(ApiKeyAuth prototype)
     
    ApiKeyAuth.Builder
    newBuilderForType()
     
    protected ApiKeyAuth.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static ApiKeyAuth
    parseDelimitedFrom(InputStream input)
     
    static ApiKeyAuth
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ApiKeyAuth
    parseFrom(byte[] data)
     
    static ApiKeyAuth
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ApiKeyAuth
    parseFrom(com.google.protobuf.ByteString data)
     
    static ApiKeyAuth
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ApiKeyAuth
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static ApiKeyAuth
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ApiKeyAuth
    parseFrom(InputStream input)
     
    static ApiKeyAuth
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ApiKeyAuth
    parseFrom(ByteBuffer data)
     
    static ApiKeyAuth
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<ApiKeyAuth>
    parser()
     
    ApiKeyAuth.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, 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.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

    • CREDENTIALS_FIELD_NUMBER

      public static final int CREDENTIALS_FIELD_NUMBER
      See Also:

    • KEY_SOURCES_FIELD_NUMBER

      public static final int KEY_SOURCES_FIELD_NUMBER
      See Also:

    • FORWARDING_FIELD_NUMBER

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

    • getCredentialsList

      public List<Credential> getCredentialsList()
       The credentials that are used to authenticate the clients.
      repeated .envoy.extensions.filters.http.api_key_auth.v3.Credential credentials = 1 [(.udpa.annotations.sensitive) = true];
      Specified by:
      getCredentialsList in interface ApiKeyAuthOrBuilder

    • getCredentialsOrBuilderList

      public List<? extends CredentialOrBuilder> getCredentialsOrBuilderList()
       The credentials that are used to authenticate the clients.
      repeated .envoy.extensions.filters.http.api_key_auth.v3.Credential credentials = 1 [(.udpa.annotations.sensitive) = true];
      Specified by:
      getCredentialsOrBuilderList in interface ApiKeyAuthOrBuilder

    • getCredentialsCount

      public int getCredentialsCount()
       The credentials that are used to authenticate the clients.
      repeated .envoy.extensions.filters.http.api_key_auth.v3.Credential credentials = 1 [(.udpa.annotations.sensitive) = true];
      Specified by:
      getCredentialsCount in interface ApiKeyAuthOrBuilder

    • getCredentials

      public Credential getCredentials(int index)
       The credentials that are used to authenticate the clients.
      repeated .envoy.extensions.filters.http.api_key_auth.v3.Credential credentials = 1 [(.udpa.annotations.sensitive) = true];
      Specified by:
      getCredentials in interface ApiKeyAuthOrBuilder

    • getCredentialsOrBuilder

      public CredentialOrBuilder getCredentialsOrBuilder(int index)
       The credentials that are used to authenticate the clients.
      repeated .envoy.extensions.filters.http.api_key_auth.v3.Credential credentials = 1 [(.udpa.annotations.sensitive) = true];
      Specified by:
      getCredentialsOrBuilder in interface ApiKeyAuthOrBuilder

    • getKeySourcesList

      public List<KeySource> getKeySourcesList()
       The key sources to fetch the key from the coming request.
      repeated .envoy.extensions.filters.http.api_key_auth.v3.KeySource key_sources = 2;
      Specified by:
      getKeySourcesList in interface ApiKeyAuthOrBuilder

    • getKeySourcesOrBuilderList

      public List<? extends KeySourceOrBuilder> getKeySourcesOrBuilderList()
       The key sources to fetch the key from the coming request.
      repeated .envoy.extensions.filters.http.api_key_auth.v3.KeySource key_sources = 2;
      Specified by:
      getKeySourcesOrBuilderList in interface ApiKeyAuthOrBuilder

    • getKeySourcesCount

      public int getKeySourcesCount()
       The key sources to fetch the key from the coming request.
      repeated .envoy.extensions.filters.http.api_key_auth.v3.KeySource key_sources = 2;
      Specified by:
      getKeySourcesCount in interface ApiKeyAuthOrBuilder

    • getKeySources

      public KeySource getKeySources(int index)
       The key sources to fetch the key from the coming request.
      repeated .envoy.extensions.filters.http.api_key_auth.v3.KeySource key_sources = 2;
      Specified by:
      getKeySources in interface ApiKeyAuthOrBuilder

    • getKeySourcesOrBuilder

      public KeySourceOrBuilder getKeySourcesOrBuilder(int index)
       The key sources to fetch the key from the coming request.
      repeated .envoy.extensions.filters.http.api_key_auth.v3.KeySource key_sources = 2;
      Specified by:
      getKeySourcesOrBuilder in interface ApiKeyAuthOrBuilder

    • hasForwarding

      public boolean hasForwarding()
       Optional configuration to control what information should be propagated to upstream services.
      .envoy.extensions.filters.http.api_key_auth.v3.Forwarding forwarding = 3;
      Specified by:
      hasForwarding in interface ApiKeyAuthOrBuilder
      Returns:
      Whether the forwarding field is set.

    • getForwarding

      public Forwarding getForwarding()
       Optional configuration to control what information should be propagated to upstream services.
      .envoy.extensions.filters.http.api_key_auth.v3.Forwarding forwarding = 3;
      Specified by:
      getForwarding in interface ApiKeyAuthOrBuilder
      Returns:
      The forwarding.

    • getForwardingOrBuilder

      public ForwardingOrBuilder getForwardingOrBuilder()
       Optional configuration to control what information should be propagated to upstream services.
      .envoy.extensions.filters.http.api_key_auth.v3.Forwarding forwarding = 3;
      Specified by:
      getForwardingOrBuilder in interface ApiKeyAuthOrBuilder

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static ApiKeyAuth.Builder newBuilder()

    • newBuilder

      public static ApiKeyAuth.Builder newBuilder(ApiKeyAuth prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static ApiKeyAuth getDefaultInstance()

    • parser

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

    • getParserForType

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