Skip to content

Latest commit

 

History

History
316 lines (238 loc) · 10.9 KB

README.md

File metadata and controls

316 lines (238 loc) · 10.9 KB
Raw

AuthBucket\Bundle\OAuth2Bundle

Build Status Coverage Status Dependency Status Latest Stable Version Total Downloads License

AuthBucket\Bundle\OAuth2Bundle is a Symfony Bundle, which integrate AuthBucket\OAuth2 as easy as possible into your Symfony Project.

Installation

Simply add a dependency on authbucket/oauth2-symfony-bundle to your project's composer.json file if you use Composer to manage the dependencies of your project.

Here is a minimal example of a composer.json:

{
    "require": {
        "authbucket/oauth2-symfony-bundle": "~2.4"
    }
}

Parameters

Example setup in our built-in demo:

# app/config/config.yml

framework:
    serializer:
        enabled: true

services:
    custom_normalizer:
        class: Symfony\Component\Serializer\Normalizer\CustomNormalizer
        tags:
            - { name: serializer.normalizer }
    get_set_method_normalizer:
        class: Symfony\Component\Serializer\Normalizer\GetSetMethodNormalizer
        tags:
            - { name: serializer.normalizer }

authbucket_oauth2:
    driver:                 orm
    user_provider:          security.user.provider.concrete.default
    model:
        access_token:       AuthBucket\Bundle\OAuth2Bundle\Tests\TestBundle\Entity\AccessToken
        authorize:          AuthBucket\Bundle\OAuth2Bundle\Tests\TestBundle\Entity\Authorize
        client:             AuthBucket\Bundle\OAuth2Bundle\Tests\TestBundle\Entity\Client
        code:               AuthBucket\Bundle\OAuth2Bundle\Tests\TestBundle\Entity\Code
        refresh_token:      AuthBucket\Bundle\OAuth2Bundle\Tests\TestBundle\Entity\RefreshToken
        scope:              AuthBucket\Bundle\OAuth2Bundle\Tests\TestBundle\Entity\Scope

Where:

  • driver: (Optional) Currently we support in-memory (in_memory), or Doctrine ORM (orm). Default with in-memory for using resource firewall with remote debug endpoint.
  • user_provider: (Optional) For using grant_type = password, override this parameter with your own user provider, e.g. using InMemoryUserProvider or a Doctrine ORM EntityRepository that implements UserProviderInterface.
  • model: (Optional) Override this with your own model classes, default with in-memory AccessToken for using resource firewall with remote debug endpoint.

Services

This bundle come with following services controller which simplify the OAuth2.0 controller implementation overhead:

  • authbucket_oauth2.oauth2_controller: OAuth2 endpoint controller.

Moreover, we also provide following model CRUD controller for alter raw data set:

  • authbucket_oauth2.authorize_controller: Authorize endpoint controller.
  • authbucket_oauth2.client_controller: Client endpoint controller.
  • authbucket_oauth2.scope_controller: Scope endpoint controller.

Registering

You have to add AuthBucketOAuth2Bundle to your AppKernel.php:

# app/AppKernel.php

class AppKernel extends Kernel
{
    public function registerBundles()
    {
        $bundles = array(
            new AuthBucket\Bundle\OAuth2Bundle\AuthBucketOAuth2Bundle(),
        );

        return $bundles;
    }
}

Usage

This library seperate the endpoint logic in frontend firewall and backend controller point of view, so you will need to setup both for functioning.

To enable the built-in controller with corresponding routing, add the following into your routing.yml, all above controllers will be enabled accordingly with routing prefix /api/v1.0:

# app/config/routing.yml

authbucketoauth2bundle:
    prefix:     /
    resource:   "@AuthBucketOAuth2Bundle/Resources/config/routing.yml"

Below is a list of recipes that cover some common use cases.

Authorization Endpoint

We don't provide custom firewall for this endpoint, which you should protect it by yourself, authenticate and capture the user credential, e.g. by SecurityBundle:

# app/config/security.yml

security:
    encoders:
        Symfony\Component\Security\Core\User\User: plaintext

    providers:
        default:
            memory:
                users:
                    demousername1:  { roles: 'ROLE_USER', password: demopassword1 }
                    demousername2:  { roles: 'ROLE_USER', password: demopassword2 }
                    demousername3:  { roles: 'ROLE_USER', password: demopassword3 }

    firewalls:
        oauth2_authorize:
            pattern:                ^/api/v1.0/oauth2/authorize$
            http_basic:             ~
            provider:               default

Token Endpoint

Similar as authorization endpoint, we need to protect this endpoint with our custom firewall oauth2_token:

# app/config/security.yml

security:
    firewalls:
        oauth2_token:
            pattern:                ^/api/v1.0/oauth2/token$
            oauth2_token:           ~

Debug Endpoint

We should protect this endpoint with our custom firewall oauth2_resource:

# app/config/security.yml

security:
    firewalls:
        oauth2_debug:
            pattern:                ^/api/v1.0/oauth2/debug$
            oauth2_resource:        ~

Resource Endpoint

We don't provide other else resource endpoint controller implementation besides above debug endpoint. You should consider implement your own endpoint with custom logic, e.g. fetching user email address or profile image.

On the other hand, you can protect your resource server endpoint with our custom firewall oauth2_resource. Shorthand version (default assume resource server bundled with authorization server, query local model manager, without scope protection):

# app/config/security.yml

security:
    firewalls:
        resource:
            pattern:                ^/api/v1.0/resource
            oauth2_resource:        ~

Longhand version (assume resource server bundled with authorization server, query local model manager, protect with scope demoscope1):

# app/config/security.yml

security:
    firewalls:
        resource:
            pattern:                ^/api/v1.0/resource
            oauth2_resource:
                resource_type:      model
                scope:              [ demoscope1 ]

If authorization server is hosting somewhere else, you can protect your local resource endpoint by query remote authorization server debug endpoint:

# app/config/security.yml

security:
    firewalls:
        resource:
            pattern:                ^/api/v1.0/resource
            oauth2_resource:
                resource_type:      debug_endpoint
                scope:              [ demoscope1 ]
                options:
                    debug_endpoint: http://example.com/api/v1.0/oauth2/debug
                    cache:          true

Demo

The demo is based on Symfony and AuthBucketOAuth2Bundle. Read though Demo for more information.

You may also run the demo locally. Open a console and execute the following command to install the latest version in the oauth2-symfony-bundle directory:

$ composer create-project authbucket/oauth2-symfony-bundle oauth2-symfony-bundle "~2.4"

Then use the PHP built-in web server to run the demo application:

$ cd oauth2-symfony-bundle
$ php app/console server:run

If you get the error There are no commands defined in the "server" namespace., then you are probably using PHP 5.3. That's ok! But the built-in web server is only available for PHP 5.4.0 or higher. If you have an older version of PHP or if you prefer a traditional web server such as Apache or Nginx, read the Configuring a web server article.

Open your browser and access the http://127.0.0.1:8000 URL to see the Welcome page of demo application.

Also access http://127.0.0.1:8000/admin/refresh_database to initialize the bundled SQLite database with user account admin:secrete.

Documentation

OAuth2Bundle's documentation is built with Sami and publicly hosted on GitHub Pages.

To built the documents locally, execute the following command:

$ vendor/bin/sami.php update .sami.php

Open build/sami/index.html with your browser for the documents.

Tests

This project is coverage with PHPUnit test cases; CI result can be found from Travis CI; code coverage report can be found from Coveralls.

To run the test suite locally, execute the following command:

$ vendor/bin/phpunit

Open build/logs/html with your browser for the coverage report.

References

License