Yancy::Plugin::Auth::OAuth2 - Authenticate using an OAuth2 provider
version 1.027
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.
Returns the access token of the currently-logged-in user.
my $subref = $c->yancy->auth->require_user;
Build a callback to validate there is a logged-in user. Since this auth module has no information about the user, there can be no additional authorization of the user.
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.
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 );
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) 2019 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.