masonite-socialite 0.0.1

Flexible Social Authentication for Masonite Framework

Masonite Socialite

Flexible Social Authentication for Masonite Framework

Masonite Socialite is an authentication package for Masonite Framework. Extremely flexible and modular, Masonite Socialite supports authentication with Facebook, Twitter, Github, LinkedIn, Google and more.

Here's a demo of how you can use it:

Installation

You can install the package via pip:

pip install masonite-socialite

Configuration

Add the Service Provider to your provider list in config/providers.py:

from socialite.providers import SocialiteProvider

PROVIDERS = [
    ...

    # Third Party Providers
    SocialiteProvider,
]

This will add a new socialite:install command to craft. Just run:

craft socialite:install

Usage

1. Configure your OAuth keys for the provider you want to use in your .env file.

# Facebook
SOCIAL_AUTH_FACEBOOK_KEY = ''
SOCIAL_AUTH_FACEBOOK_SECRET = ''

# Twitter
SOCIAL_AUTH_TWITTER_KEY = ''
SOCIAL_AUTH_TWITTER_SECRET = ''

# Google
SOCIAL_AUTH_GOOGLE_OAUTH_KEY = ''
SOCIAL_AUTH_GOOGLE_OAUTH_SECRET = ''

# Github
SOCIAL_AUTH_GITHUB_KEY = ''
SOCIAL_AUTH_GITHUB_SECRET = ''

# LinkedIn
SOCIAL_AUTH_LINKEDIN_KEY = ''
SOCIAL_AUTH_LINKEDIN_SECRET = ''

2. In your controller, SocialAuthController for example, put the following code:

from masonite.controllers import Controller
from masonite.request import Request

from socialite import Socialite


class SocialAuthController(Controller):
    """Controller For Social Authentication."""

    def redirect_to_provider(self, request: Request, socialite: Socialite):
        """Redirect the user to the authentication page"""
        return socialite.driver('auth').redirect()

    def handle_provider_callback(self, request: Request, socialite: Socialite):
        """Obtain the user information"""
        user = socialite.driver('auth').user()
        # => print(user)
        return request.redirect('/home')

3. You need to define the routes:

from masonite.routes import Get, RouteGroup, Post

from config.socialite import SOCIAL_AUTH_PREFIX

ROUTES = [
    ....
    RouteGroup([
        Get(f'/{SOCIAL_AUTH_PREFIX}/@backend/login', 'SocialAuthController@redirect_to_provider'),
        Get(f'/{SOCIAL_AUTH_PREFIX}/@backend/callback', 'SocialAuthController@handle_provider_callback'),
    ], middleware=('socialite.backend', )),
    ....
]

The uri routes need to be started by SOCIAL_AUTH_PREFIX Without that your callback may be wrong.

SOCIAL_AUTH_NAMESPACE = "social"

Visit, http://localhost:8000/social/facebook/login/