README

Lightweight simple and flexible OAuth2 Server
With support of the JSON Web Token
Customizable user suthentication and storage of the token records
Designed based on IoC

For more details see Presentation and OAuth2 API documentation.

Requirements

PHP 8.x

Installation

composer require smartfactory/oauth2"

composer.json

{
  ...

  "require": {
    "php": ">=8.0",
    "smartfactory/smartfactory": ">=2.1.21",
    "smartfactory/oauth2": ">=1.2.21"
  }
  
  ...
}

To get familiar with the SmartFactory Core and OAuth2 Server do the following:

Git-clone the demo application SmartFactoryDemo and run 'composer update'.
Use the script database/create_database_mysql.sql (create_database_mssql.sql) to create a demo database necessary for some examples.
View and study the API documentation in the folder docs or here OAuth2 API documentation.
Study the core code of the library SmartFactory and SmartFactory OAuth2 Server.
The example 18.oauth.php demonstrates usage of the SmartFactory OAuth2 Server.

To start writing own application using SmartFactory OAuth2 Server

Git-clone the demo application SmartFactoryDemo and run 'composer update'.
Study the directory structure of the demo application and the code.
Implement the interfaces IUserAuthenticator and IUserAuthenticator.
Bind you classes to the interfaces in the file initialization_inc.php to be able to use the IoC approach for creating objects offered by the library SmartFactory.
Implement the JSON API request handlers.
Add translation texts for your application over the localization/edit.php or directly into the JSON file localization/texts.json. Use the script localization/check.php to check your translations for missing translations.

Directory Structure

docs
src
  OAuth2
    Interfaces

Detailed description

docs

This directory contains the documentation about classes, interfaces and functions of the SmartFactory OAuth2 Server.

src

This is the root directory for all classes and interfaces. The class loader is implemented based on PSR4 approach. You have no need to add additional class loader function.

src/OAuth2

This directory contains the core classes and interfaces of the SmartFactory OAuth2 Server.

src/OAuth2/Interfaces

This directory contains the core interfaces of the SmartFactory OAuth2 Server.

smartfactory / oauth2

Maintainers

Details