Guzzle Bundle OAuth2 Plugin

This plugin integrates OAuth2 functionality into Guzzle Bundle, a bundle for building RESTful web service clients.

Requirements

Installation

composer.json

{
    "require": {
        "gregurco/guzzle-bundle-oauth2-plugin": "dev-master"
    }
}

command line

$ composer require gregurco/guzzle-bundle-oauth2-plugin

Usage

Enable bundle

# app/AppKernel.php

new EightPoints\Bundle\GuzzleBundle\EightPointsGuzzleBundle([
    new Gregurco\Bundle\GuzzleBundleOAuth2Plugin\GuzzleBundleOAuth2Plugin(),
])

Basic configuration

With default grant type (client)

# app/config/config.yml

eight_points_guzzle:
    clients:
        api_payment:
            base_url: "http://api.domain.tld"
            
            auth: oauth2

            # plugin settings
            plugin:
                oauth2:
                    base_uri:       "https://example.com"
                    token_url:      "/oauth/token"
                    client_id:      "test-client-id"
                    client_secret:  "test-client-secret" # optional
                    scope:          "administration"

With password grant type

# app/config/config.yml

eight_points_guzzle:
    clients:
        api_payment:
            base_url: "http://api.domain.tld"
            
            auth: oauth2

            # plugin settings
            plugin:
                oauth2:
                    base_uri:       "https://example.com"
                    token_url:      "/oauth/token"
                    client_id:      "test-client-id"
                    username:       "johndoe"
                    password:       "A3ddj3w"
                    scope:          "administration"
                    grant_type:     "Sainsburys\\Guzzle\\Oauth2\\GrantType\\PasswordCredentials"

With client credentials in body

# app/config/config.yml

eight_points_guzzle:
    clients:
        api_payment:
            base_url: "http://api.domain.tld"
            
            auth: oauth2

            # plugin settings
            plugin:
                oauth2:
                    base_uri:       "https://example.com"
                    token_url:      "/oauth/token"
                    client_id:      "test-client-id"
                    scope:          "administration"
                    auth_location:  "body"

Options

Key	Description	Required	Example
base_uri	URL of oAuth2 server.	yes	https://example.com
token_url	The path that will be concatenated with base_uri. Default: `/oauth2/token`	no	/oauth/token
client_id	The client identifier issued to the client during the registration process	yes	s6BhdRkqt3
client_secret	The client secret	no	7Fjfp0ZBr1KtDRbnfVdmIw
username	The resource owner username	for PasswordCredentials grant type	johndoe
password	The resource owner password	for PasswordCredentials grant type	A3ddj3w
auth_location	The place where to put client_id and client_secret in auth request. Default: headers. Allowed values: body, headers.	no	body
resource	The App ID URI of the web API (secured resource)	no	https://service.contoso.com/
private_key	Path to private key	for JwtBearer grant type	`"%kernel.root_dir%/path/to/private.key"`
scope	One or more scope values indicating which parts of the user's account you wish to access	no	administration
grant_type	Grant type class path. Class should implement GrantTypeInterface. Default: `Sainsburys\\Guzzle\\Oauth2\\GrantType\\ClientCredentials`	no	`Sainsburys\\Guzzle\\Oauth2\\GrantType\\PasswordCredentials` `Sainsburys\\Guzzle\\Oauth2\\GrantType\\AuthorizationCode` `Sainsburys\\Guzzle\\Oauth2\\GrantType\\JwtBearer`

See more information about middleware here.

License

This middleware is licensed under the MIT License - see the LICENSE file for details

Neirda24/GuzzleBundleOAuth2Plugin