Skip to content

jfm-drapo/oauth2-franceconnect

Repository files navigation

oauth2-franceconnect

Latest Version on Packagist Software License Build Status Coverage Status Quality Score Total Downloads

This package provides France Connect OAuth 2.0 support for the PHP League's OAuth 2.0 Client.

Install

Via Composer

$ composer require jefdigital/oauth2-franceconnect

Usage

Usage is the same as The League's OAuth client, using \JefDigital\OAuth2\Client\Provider\FranceConnect as the provider.

Authorization Code Flow

<?php

session_start();

$provider = new \JefDigital\OAuth2\Client\Provider\FranceConnect([
    'clientId'                => '{fc-client-id}',
    'clientSecret'            => '{fc-client-secret}',
    'redirectUri'             => 'https://example.com/callback-url',
    'baseAuthorizationUrl'    => 'https://example.com/base-auth-url',
    'baseAccessTokenUrl'      => 'https://example.com/base-access-url',
    'resourceOwnerDetailsUrl' => 'https://example.com/resource-owner-url',
]);

if (!isset($_GET['code'])) {

    // If we don't have an authorization code then get one
    $authUrl = $provider->getAuthorizationUrl();
    $_SESSION['oauth2state'] = $provider->getState();
    header('Location: '.$authUrl);
    exit;

// Check given state against previously stored one to mitigate CSRF attack
} elseif (empty($_GET['state']) || ($_GET['state'] !== $_SESSION['oauth2state'])) {

    unset($_SESSION['oauth2state']);
    exit('Invalid state');

} else {

    // Try to get an access token (using the authorization code grant)
    $token = $provider->getAccessToken('authorization_code', [
        'code' => $_GET['code']
    ]);

    // Optional: Now you have a token you can look up a users profile data
    try {

        // We got an access token, let's now get the user's details
        $user = $provider->getResourceOwner($token);

        // Use these details to create a new profile
        printf('Hello %s!', $user->getGivenName());

    } catch (Exception $e) {

        // Failed to get user details
        exit('Oh dear...');
    }

    // Use this to interact with an API on the users behalf
    echo $token->getToken();
}

Testing

$ composer test

Contributing

Please see CONTRIBUTING for details.

Credits

License

The MIT License (MIT). Please see License File for more information.

About

France Connect OAuth 2.0 Client Provider for The PHP League OAuth2-Client

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages