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

Class OAuth2Config

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, OAuth2ConfigOrBuilder, Serializable
    public final class OAuth2Config
extends com.google.protobuf.GeneratedMessageV3
implements OAuth2ConfigOrBuilder
     OAuth config
 [#next-free-field: 11]
    Protobuf type envoy.extensions.filters.http.oauth2.v3.OAuth2Config
    See Also:
    Serialized Form

    • Field Detail

      • TOKEN_ENDPOINT_FIELD_NUMBER

        public static final int TOKEN_ENDPOINT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • AUTHORIZATION_ENDPOINT_FIELD_NUMBER

        public static final int AUTHORIZATION_ENDPOINT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CREDENTIALS_FIELD_NUMBER

        public static final int CREDENTIALS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • REDIRECT_URI_FIELD_NUMBER

        public static final int REDIRECT_URI_FIELD_NUMBER
        See Also:
        Constant Field Values

      • REDIRECT_PATH_MATCHER_FIELD_NUMBER

        public static final int REDIRECT_PATH_MATCHER_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SIGNOUT_PATH_FIELD_NUMBER

        public static final int SIGNOUT_PATH_FIELD_NUMBER
        See Also:
        Constant Field Values

      • FORWARD_BEARER_TOKEN_FIELD_NUMBER

        public static final int FORWARD_BEARER_TOKEN_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PASS_THROUGH_MATCHER_FIELD_NUMBER

        public static final int PASS_THROUGH_MATCHER_FIELD_NUMBER
        See Also:
        Constant Field Values

      • AUTH_SCOPES_FIELD_NUMBER

        public static final int AUTH_SCOPES_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

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

      • 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

      • hasTokenEndpoint

        public boolean hasTokenEndpoint()
         Endpoint on the authorization server to retrieve the access token from.
        .envoy.config.core.v3.HttpUri token_endpoint = 1;
        Specified by:
        hasTokenEndpoint in interface OAuth2ConfigOrBuilder
        Returns:
        Whether the tokenEndpoint field is set.

      • getTokenEndpoint

        public HttpUri getTokenEndpoint()
         Endpoint on the authorization server to retrieve the access token from.
        .envoy.config.core.v3.HttpUri token_endpoint = 1;
        Specified by:
        getTokenEndpoint in interface OAuth2ConfigOrBuilder
        Returns:
        The tokenEndpoint.

      • getAuthorizationEndpoint

        public String getAuthorizationEndpoint()
         The endpoint redirect to for authorization in response to unauthorized requests.
        string authorization_endpoint = 2 [(.validate.rules) = { ... }
        Specified by:
        getAuthorizationEndpoint in interface OAuth2ConfigOrBuilder
        Returns:
        The authorizationEndpoint.

      • getAuthorizationEndpointBytes

        public com.google.protobuf.ByteString getAuthorizationEndpointBytes()
         The endpoint redirect to for authorization in response to unauthorized requests.
        string authorization_endpoint = 2 [(.validate.rules) = { ... }
        Specified by:
        getAuthorizationEndpointBytes in interface OAuth2ConfigOrBuilder
        Returns:
        The bytes for authorizationEndpoint.

      • hasCredentials

        public boolean hasCredentials()
         Credentials used for OAuth.
        .envoy.extensions.filters.http.oauth2.v3.OAuth2Credentials credentials = 3 [(.validate.rules) = { ... }
        Specified by:
        hasCredentials in interface OAuth2ConfigOrBuilder
        Returns:
        Whether the credentials field is set.

      • getCredentials

        public OAuth2Credentials getCredentials()
         Credentials used for OAuth.
        .envoy.extensions.filters.http.oauth2.v3.OAuth2Credentials credentials = 3 [(.validate.rules) = { ... }
        Specified by:
        getCredentials in interface OAuth2ConfigOrBuilder
        Returns:
        The credentials.

      • getRedirectUri

        public String getRedirectUri()
         The redirect URI passed to the authorization endpoint. Supports header formatting
 tokens. For more information, including details on header value syntax, see the
 documentation on :ref:`custom request headers <config_http_conn_man_headers_custom_request_headers>`.
 This URI should not contain any query parameters.
        string redirect_uri = 4 [(.validate.rules) = { ... }
        Specified by:
        getRedirectUri in interface OAuth2ConfigOrBuilder
        Returns:
        The redirectUri.

      • getRedirectUriBytes

        public com.google.protobuf.ByteString getRedirectUriBytes()
         The redirect URI passed to the authorization endpoint. Supports header formatting
 tokens. For more information, including details on header value syntax, see the
 documentation on :ref:`custom request headers <config_http_conn_man_headers_custom_request_headers>`.
 This URI should not contain any query parameters.
        string redirect_uri = 4 [(.validate.rules) = { ... }
        Specified by:
        getRedirectUriBytes in interface OAuth2ConfigOrBuilder
        Returns:
        The bytes for redirectUri.

      • hasRedirectPathMatcher

        public boolean hasRedirectPathMatcher()
         Matching criteria used to determine whether a path appears to be the result of a redirect from the authorization server.
        .envoy.type.matcher.v3.PathMatcher redirect_path_matcher = 5 [(.validate.rules) = { ... }
        Specified by:
        hasRedirectPathMatcher in interface OAuth2ConfigOrBuilder
        Returns:
        Whether the redirectPathMatcher field is set.

      • getRedirectPathMatcher

        public PathMatcher getRedirectPathMatcher()
         Matching criteria used to determine whether a path appears to be the result of a redirect from the authorization server.
        .envoy.type.matcher.v3.PathMatcher redirect_path_matcher = 5 [(.validate.rules) = { ... }
        Specified by:
        getRedirectPathMatcher in interface OAuth2ConfigOrBuilder
        Returns:
        The redirectPathMatcher.

      • getRedirectPathMatcherOrBuilder

        public PathMatcherOrBuilder getRedirectPathMatcherOrBuilder()
         Matching criteria used to determine whether a path appears to be the result of a redirect from the authorization server.
        .envoy.type.matcher.v3.PathMatcher redirect_path_matcher = 5 [(.validate.rules) = { ... }
        Specified by:
        getRedirectPathMatcherOrBuilder in interface OAuth2ConfigOrBuilder

      • hasSignoutPath

        public boolean hasSignoutPath()
         The path to sign a user out, clearing their credential cookies.
        .envoy.type.matcher.v3.PathMatcher signout_path = 6 [(.validate.rules) = { ... }
        Specified by:
        hasSignoutPath in interface OAuth2ConfigOrBuilder
        Returns:
        Whether the signoutPath field is set.

      • getSignoutPath

        public PathMatcher getSignoutPath()
         The path to sign a user out, clearing their credential cookies.
        .envoy.type.matcher.v3.PathMatcher signout_path = 6 [(.validate.rules) = { ... }
        Specified by:
        getSignoutPath in interface OAuth2ConfigOrBuilder
        Returns:
        The signoutPath.

      • getForwardBearerToken

        public boolean getForwardBearerToken()
         Forward the OAuth token as a Bearer to upstream web service.
        bool forward_bearer_token = 7;
        Specified by:
        getForwardBearerToken in interface OAuth2ConfigOrBuilder
        Returns:
        The forwardBearerToken.

      • getPassThroughMatcherList

        public List<HeaderMatcher> getPassThroughMatcherList()
         Any request that matches any of the provided matchers will be passed through without OAuth validation.
        repeated .envoy.config.route.v3.HeaderMatcher pass_through_matcher = 8;
        Specified by:
        getPassThroughMatcherList in interface OAuth2ConfigOrBuilder

      • getPassThroughMatcherCount

        public int getPassThroughMatcherCount()
         Any request that matches any of the provided matchers will be passed through without OAuth validation.
        repeated .envoy.config.route.v3.HeaderMatcher pass_through_matcher = 8;
        Specified by:
        getPassThroughMatcherCount in interface OAuth2ConfigOrBuilder

      • getPassThroughMatcher

        public HeaderMatcher getPassThroughMatcher​(int index)
         Any request that matches any of the provided matchers will be passed through without OAuth validation.
        repeated .envoy.config.route.v3.HeaderMatcher pass_through_matcher = 8;
        Specified by:
        getPassThroughMatcher in interface OAuth2ConfigOrBuilder

      • getPassThroughMatcherOrBuilder

        public HeaderMatcherOrBuilder getPassThroughMatcherOrBuilder​(int index)
         Any request that matches any of the provided matchers will be passed through without OAuth validation.
        repeated .envoy.config.route.v3.HeaderMatcher pass_through_matcher = 8;
        Specified by:
        getPassThroughMatcherOrBuilder in interface OAuth2ConfigOrBuilder

      • getAuthScopesList

        public com.google.protobuf.ProtocolStringList getAuthScopesList()
         Optional list of OAuth scopes to be claimed in the authorization request. If not specified,
 defaults to "user" scope.
 OAuth RFC https://tools.ietf.org/html/rfc6749#section-3.3
        repeated string auth_scopes = 9;
        Specified by:
        getAuthScopesList in interface OAuth2ConfigOrBuilder
        Returns:
        A list containing the authScopes.

      • getAuthScopesCount

        public int getAuthScopesCount()
         Optional list of OAuth scopes to be claimed in the authorization request. If not specified,
 defaults to "user" scope.
 OAuth RFC https://tools.ietf.org/html/rfc6749#section-3.3
        repeated string auth_scopes = 9;
        Specified by:
        getAuthScopesCount in interface OAuth2ConfigOrBuilder
        Returns:
        The count of authScopes.

      • getAuthScopes

        public String getAuthScopes​(int index)
         Optional list of OAuth scopes to be claimed in the authorization request. If not specified,
 defaults to "user" scope.
 OAuth RFC https://tools.ietf.org/html/rfc6749#section-3.3
        repeated string auth_scopes = 9;
        Specified by:
        getAuthScopes in interface OAuth2ConfigOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The authScopes at the given index.

      • getAuthScopesBytes

        public com.google.protobuf.ByteString getAuthScopesBytes​(int index)
         Optional list of OAuth scopes to be claimed in the authorization request. If not specified,
 defaults to "user" scope.
 OAuth RFC https://tools.ietf.org/html/rfc6749#section-3.3
        repeated string auth_scopes = 9;
        Specified by:
        getAuthScopesBytes in interface OAuth2ConfigOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the authScopes at the given index.

      • getResourcesList

        public com.google.protobuf.ProtocolStringList getResourcesList()
         Optional resource parameter for authorization request
 RFC: https://tools.ietf.org/html/rfc8707
        repeated string resources = 10;
        Specified by:
        getResourcesList in interface OAuth2ConfigOrBuilder
        Returns:
        A list containing the resources.

      • getResourcesCount

        public int getResourcesCount()
         Optional resource parameter for authorization request
 RFC: https://tools.ietf.org/html/rfc8707
        repeated string resources = 10;
        Specified by:
        getResourcesCount in interface OAuth2ConfigOrBuilder
        Returns:
        The count of resources.

      • getResources

        public String getResources​(int index)
         Optional resource parameter for authorization request
 RFC: https://tools.ietf.org/html/rfc8707
        repeated string resources = 10;
        Specified by:
        getResources in interface OAuth2ConfigOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The resources at the given index.

      • getResourcesBytes

        public com.google.protobuf.ByteString getResourcesBytes​(int index)
         Optional resource parameter for authorization request
 RFC: https://tools.ietf.org/html/rfc8707
        repeated string resources = 10;
        Specified by:
        getResourcesBytes in interface OAuth2ConfigOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the resources at the given index.

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static OAuth2Config getDefaultInstance()

      • parser

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

      • getParserForType

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