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

Interface BasicAuthOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
BasicAuth, BasicAuth.Builder
public interface BasicAuthOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    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.
    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.
    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.
    boolean
    hasUsers()
    Username-password pairs used to verify user credentials in the "Authorization" header.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • hasUsers

      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];
      Returns:
      Whether the users field is set.

    • getUsers

      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];
      Returns:
      The users.

    • getUsersOrBuilder

      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];

    • getForwardUsernameHeader

      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) = { ... }
      Returns:
      The forwardUsernameHeader.

    • getForwardUsernameHeaderBytes

      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) = { ... }
      Returns:
      The bytes for forwardUsernameHeader.

    • getAuthenticationHeader

      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) = { ... }
      Returns:
      The authenticationHeader.

    • getAuthenticationHeaderBytes

      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) = { ... }
      Returns:
      The bytes for authenticationHeader.