Plack::Middleware::Auth::OAuth2::ProtectedResource(3pm)

Plack::Middleware::Auth::OAuth2::ProtectedResource3pm

Middleware for oauth 2.0 protected resource endpoint

Usage

    my $app = sub {...};
    builder {
        enable "Plack::Middleware::Auth::OAuth2::ProtectedResource",
            data_handler => "YourApp::DataHandler",
            error_uri    => q{http://example.org/error/description};
        enable "Plack::Middleware::JSONP";
        enable "Plack::Middleware::ContentLength";
        $app;
    };
    # and on your controller
    $plack_request->env->{REMOTE_USER};
    $plack_request->env->{X_OAUTH_CLIENT_ID};
    $plack_request->env->{X_OAUTH_SCOPE};

Overview

middleware for OAuth 2.0 Protected Resource endpoint

Methods

call( $env )

This method parses access token. If access token is valid, authorization information are set to environment variables.

Env values

After successful verifying authorization within middleware layer, Following 3 type of values are set in env.

REMOTE_USER

Identifier of user who grant the client to access the user's protected resource that is stored on service provider.

X_OAUTH_CLIENT

Identifier of the client that accesses to user's protected resource on beharf of the user.

X_OAUTH_SCOPE

Scope parameter that represents what kind of resources that the user grant client to access.

Releases

2 releases since Debian 12 (Bookworm); the text changed 1 time.

  1. 12
  2. 13

Author

Lyo Kato, <[email protected]>

From liboauth-lite2-perl 0.11-3 in Debian 13 (Trixie). Parsed by carta from the page's man source.