Yancy::Plugin::Auth::OAuth2 - Authenticate using an OAuth2 provider
version 1.061
use Mojolicious::Lite; plugin Yancy => { backend => 'sqlite://myapp.db', }; app->yancy->plugin( 'Auth::OAuth2' => { client_id => 'CLIENT_ID', client_secret => 'SECRET', authorize_url => 'https://example.com/auth', token_url => 'https://example.com/token', } );
This module allows authenticating using a standard OAuth2 provider by implementing the OAuth2 specification.
OAuth2 provides no mechanism for transmitting any information about the user in question, so this auth may require some customization to be useful. Without some kind of information about the user, it is impossible to know if this is a new user or a returning user or to maintain any kind of account information for the user.
This module composes the Yancy::Auth::Plugin::Role::RequireUser role to provide the require_user authorization method.
Returns the access token of the currently-logged-in user.
Clear any currently-logged-in user.
Get a link to log in using this OAuth2 provider.
my $url = $self->get_authorize_url( $c );
Get a full authorization URL with query parameters. Override this in a subclass to customize the authorization parameters.
my $p = $self->handle_token_p( $c, $token );
Handle the receipt of the token. Override this in a subclass to make any API requests to identify the user. Returns a Mojo::Promise that will be fulfilled when the information is complete.
This plugin has the following configuration options.
The client ID, provided by the OAuth2 provider.
The client secret, provided by the OAuth2 provider.
The URL to start the OAuth2 authorization process.
The URL to get an access token. The second step of the auth process.
The label for the button to log in using this OAuth2 provider. Defaults to Login.
Login
This module uses Mojolicious sessions to store the login information in a secure, signed cookie.
To configure the default expiration of a session, use Mojolicious::Sessions default_expiration.
use Mojolicious::Lite; # Expire a session after 1 day of inactivity app->sessions->default_expiration( 24 * 60 * 60 );
This plugin has the following helpers.
Get the current user from the session, if any. Returns undef if no user was found in the session.
undef
my $user = $c->yancy->auth->current_user || return $c->render( status => 401, text => 'Unauthorized' );
Validate there is a logged-in user and optionally that the user data has certain values. See "require_user" in Yancy::Plugin::Auth::Role::RequireUser.
# Display the user dashboard, but only to logged-in users my $auth_route = $app->routes->under( '/user', $app->yancy->auth->require_user ); $auth_route->get( '' )->to( 'user#dashboard' );
Returns the rendered login button.
Login with OAuth2: %= $c->yancy->auth->login_form
Log out any current account from any auth plugin. Use this in your own route handlers to perform a logout.
To override these templates, add your own at the designated path inside your app's templates/ directory.
templates/
Display the button to log in using this OAuth2 provider.
The layout that Yancy uses when displaying the login form, the unauthorized error message, and other auth-related pages.
Yancy::Plugin::Auth
Doug Bell <preaction@cpan.org>
This software is copyright (c) 2020 by Doug Bell.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
To install Yancy, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Yancy
CPAN shell
perl -MCPAN -e shell install Yancy
For more information on module installation, please visit the detailed CPAN module installation guide.