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

Class BasicAuth

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.filters.http.basic_auth.v3.BasicAuth
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, BasicAuthOrBuilder, Serializable
public final class BasicAuth extends com.google.protobuf.GeneratedMessageV3 implements BasicAuthOrBuilder
 Basic HTTP authentication.

 Example:

 .. code-block:: yaml

   users:
     inline_string: |-
       user1:{SHA}hashed_user1_password
       user2:{SHA}hashed_user2_password
Protobuf type envoy.extensions.filters.http.basic_auth.v3.BasicAuth
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    BasicAuth.Builder
    Basic 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
    AUTHENTICATION_HEADER_FIELD_NUMBER
     
    static final int
    FORWARD_USERNAME_HEADER_FIELD_NUMBER
     
    static final int
    USERS_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)
     
    String
    getAuthenticationHeader()
    This field specifies the request header to load the basic credential from.
    com.google.protobuf.ByteString
    getAuthenticationHeaderBytes()
    This field specifies the request header to load the basic credential from.
    static BasicAuth
    getDefaultInstance()
     
    BasicAuth
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getForwardUsernameHeader()
    This field specifies the header name to forward a successfully authenticated user to the backend.
    com.google.protobuf.ByteString
    getForwardUsernameHeaderBytes()
    This field specifies the header name to forward a successfully authenticated user to the backend.
    com.google.protobuf.Parser<BasicAuth>
    getParserForType()
     
    int
    getSerializedSize()
     
    DataSource
    getUsers()
    Username-password pairs used to verify user credentials in the "Authorization" header.
    DataSourceOrBuilder
    getUsersOrBuilder()
    Username-password pairs used to verify user credentials in the "Authorization" header.
    int
    hashCode()
     
    boolean
    hasUsers()
    Username-password pairs used to verify user credentials in the "Authorization" header.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static BasicAuth.Builder
    newBuilder()
     
    static BasicAuth.Builder
    newBuilder(BasicAuth prototype)
     
    BasicAuth.Builder
    newBuilderForType()
     
    protected BasicAuth.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static BasicAuth
    parseDelimitedFrom(InputStream input)
     
    static BasicAuth
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static BasicAuth
    parseFrom(byte[] data)
     
    static BasicAuth
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static BasicAuth
    parseFrom(com.google.protobuf.ByteString data)
     
    static BasicAuth
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static BasicAuth
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static BasicAuth
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static BasicAuth
    parseFrom(InputStream input)
     
    static BasicAuth
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static BasicAuth
    parseFrom(ByteBuffer data)
     
    static BasicAuth
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<BasicAuth>
    parser()
     
    BasicAuth.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

    • USERS_FIELD_NUMBER

      public static final int USERS_FIELD_NUMBER
      See Also:

    • FORWARD_USERNAME_HEADER_FIELD_NUMBER

      public static final int FORWARD_USERNAME_HEADER_FIELD_NUMBER
      See Also:

    • AUTHENTICATION_HEADER_FIELD_NUMBER

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

    • hasUsers

      public boolean hasUsers()
       Username-password pairs used to verify user credentials in the "Authorization" header.
 The value needs to be the htpasswd format.
 Reference to https://httpd.apache.org/docs/2.4/programs/htpasswd.html
      .envoy.config.core.v3.DataSource users = 1 [(.udpa.annotations.sensitive) = true];
      Specified by:
      hasUsers in interface BasicAuthOrBuilder
      Returns:
      Whether the users field is set.

    • getUsers

      public DataSource getUsers()
       Username-password pairs used to verify user credentials in the "Authorization" header.
 The value needs to be the htpasswd format.
 Reference to https://httpd.apache.org/docs/2.4/programs/htpasswd.html
      .envoy.config.core.v3.DataSource users = 1 [(.udpa.annotations.sensitive) = true];
      Specified by:
      getUsers in interface BasicAuthOrBuilder
      Returns:
      The users.

    • getUsersOrBuilder

      public DataSourceOrBuilder getUsersOrBuilder()
       Username-password pairs used to verify user credentials in the "Authorization" header.
 The value needs to be the htpasswd format.
 Reference to https://httpd.apache.org/docs/2.4/programs/htpasswd.html
      .envoy.config.core.v3.DataSource users = 1 [(.udpa.annotations.sensitive) = true];
      Specified by:
      getUsersOrBuilder in interface BasicAuthOrBuilder

    • getForwardUsernameHeader

      public String getForwardUsernameHeader()
       This field specifies the header name to forward a successfully authenticated user to
 the backend. The header will be added to the request with the username as the value.

 If it is not specified, the username will not be forwarded.
      string forward_username_header = 2 [(.validate.rules) = { ... }
      Specified by:
      getForwardUsernameHeader in interface BasicAuthOrBuilder
      Returns:
      The forwardUsernameHeader.

    • getForwardUsernameHeaderBytes

      public com.google.protobuf.ByteString getForwardUsernameHeaderBytes()
       This field specifies the header name to forward a successfully authenticated user to
 the backend. The header will be added to the request with the username as the value.

 If it is not specified, the username will not be forwarded.
      string forward_username_header = 2 [(.validate.rules) = { ... }
      Specified by:
      getForwardUsernameHeaderBytes in interface BasicAuthOrBuilder
      Returns:
      The bytes for forwardUsernameHeader.

    • getAuthenticationHeader

      public String getAuthenticationHeader()
       This field specifies the request header to load the basic credential from.

 If it is not specified, the filter loads the credential from  the "Authorization" header.
      string authentication_header = 3 [(.validate.rules) = { ... }
      Specified by:
      getAuthenticationHeader in interface BasicAuthOrBuilder
      Returns:
      The authenticationHeader.

    • getAuthenticationHeaderBytes

      public com.google.protobuf.ByteString getAuthenticationHeaderBytes()
       This field specifies the request header to load the basic credential from.

 If it is not specified, the filter loads the credential from  the "Authorization" header.
      string authentication_header = 3 [(.validate.rules) = { ... }
      Specified by:
      getAuthenticationHeaderBytes in interface BasicAuthOrBuilder
      Returns:
      The bytes for authenticationHeader.

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static BasicAuth.Builder newBuilder()

    • newBuilder

      public static BasicAuth.Builder newBuilder(BasicAuth prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static BasicAuth getDefaultInstance()

    • parser

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

    • getParserForType

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