Yancy::Plugin::Auth::Github - Authenticate using Github's OAuth2 provider
version 1.031
use Mojolicious::Lite; plugin Yancy => { backend => 'sqlite://myapp.db', }; app->yancy->plugin( 'Auth::Github' => { client_id => 'CLIENT_ID', client_secret => $ENV{ OAUTH_GITHUB_SECRET }, schema => 'users', username_field => 'username', # TODO: Get other user information from Github, requesting # scopes if necessary } );
This module allows authenticating using the Github OAuth2 API.
Returns the user row of the currently-logged-in user.
my $subref = $c->yancy->auth->require_user( \%match );
Build a callback to validate there is a logged-in user, and optionally that the current user has certain fields set. \%match is optional and is a SQL::Abstract where clause matched with "match" in Yancy::Util.
\%match
# Ensure the user is logged-in my $user_cb = $app->yancy->auth->require_user; my $user_only = $app->routes->under( $user_cb ); # Ensure the user's "is_admin" field is set to 1 my $admin_cb = $app->yancy->auth->require_user( { is_admin => 1 } ); my $admin_only = $app->routes->under( $admin_cb );
This plugin has the following configuration options.
The client ID, provided by Github.
The client secret, provided by Github.
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, Yancy::Plugin::Auth::OAuth2
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.