Skip to content

Latest commit

 

History

History
114 lines (79 loc) · 3.53 KB

README.md

File metadata and controls

114 lines (79 loc) · 3.53 KB
Raw

Microsoft ADFS Provider for OAuth 2.0 Client

Latest Version Build Status Coverage Status Total Downloads Software License

This package provides Microsoft ADFS OAuth 2.0 support for the PHP League's OAuth 2.0 Client.

Installation

To install, use composer:

composer require b3-it/oauth2-adfs

Usage

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

Authorization Code Flow

$provider = new B3it\OAuth2\Client\Provider\Adfs([
    // Required
    'clientId'                  => '{microsoft-client-id}',
    'clientSecret'              => '{microsoft-client-secret}',
    'authServerUrl'             => 'https://my.ms-server.de/adfs',
    // Optional
    'redirectUri'               => 'https://example.com/callback-url',
    'resource'                  => 'https://example.com'
    
]);

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->geName());

    } 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();
}

Managing Scopes and State

When creating your Microsoft ADFS authorization URL, you can specify the state and scopes your application may authorize.

$options = [
    'scope' => ['allatclaims', 'openid'] // array or string
];

$authorizationUrl = $provider->getAuthorizationUrl($options);

If neither are defined, the provider will utilize internal defaults.

At the time of authoring this documentation, the following scopes are available.

Scopes
  • logon_cert
  • aza
  • allatclaims
  • email
  • profile
  • winhello_cert
  • openid
  • vpn_cert
  • user_impersonation

Credits

License

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