Download the PHP package izub/oauth2-provider without Composer

OAuth 2 Provider Module for Zend Framework 3

master: develop:

OAuth2Provider module integrates Brent Shaffer's OAuth2 Server with Zend Framework 3 easily.

Installation

1. Easiest is through composer.

   or in composer.json

   then run composer update

2. Setup your configuration
   • Create 'oauth2provider' config key in your application's module.config.php
   • Copy the contents from OAuth2Provider/config/module.config.php.dist or rename this file to module.config.php if you dont have an existing module.config.php. If copying, make sure to copy only the data inside the 'oauth2provider' config key.
   • Fill up the configuration with your own settings. Refer to Configuration Options for documentation below.

3. Define the main_server

   • Under the oauth2provider config key should be a main_server configuration.

   • Fill the main_server key with the custom server name you defined from step 2. The main_server will use the name default as the default name for a server key.

     Example:

4. Enable the OAuth2Provider module in your application.config.php

Configuration Options

You can also view the configuration documentation in configs/oauth2provider.config.php. Each configuration section has its own config options that can be viewed separately in OAuth2Provider\Options\*

Usage

• You can access the server through the main Service Manager by:
  $sm->get('oauth2provider.server.main');
  or if you have a specific server key will be:
  $sm->get('oauth2provider.server.my_custom_server_key');
• You can also access each configuration (for example: 'grant_type') object by:
  $sm->get('oauth2provider.server.main.grant_type.user_credentials');
• Access the server's Request object by:
  $sm->get('oauth2provider.server.main.request');
• Access the server's Response object by:
  $sm->get('oauth2provider.server.main.response');

Routing

• The url below will automatically be created:
  • Request end point: http://[domain]/oauth2/request
  • Resource end point: http://[domain]/oauth2/resource
  • Authorize end point: http://[domain]/oauth2/authorize

Multiple Server Versions

• You can define specific and multiple versions for your server:

  • With the above config setup, an end point of http://[domain]/oauth2/request will automatically point to 'v2'
  • You should still be able to access version1 (v1) by specifying the version in the url as such:
    http://[domain]/oauth2/v1/request

Controllers

• Currently only a 2 legged with grant_type 'user_credentials' controller is available but you can apply your own controller by implementing interface OAuth2Provider\Controller\ControllerInterface and defining the controler in:

  • the endpoints/routing above will still be valid