Download the PHP package lucinda/oauth2-client without Composer

On this page you can find all versions of the php package lucinda/oauth2-client. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of lucinda/oauth2-client

Informations about the package oauth2-client

OAuth2 Client API

Table of contents:

About

This API, came by the idea of building a shared driver based on IETF specs that abstracts communication with popular OAuth2 providers so you're no longer forced to work their bloated PHP clients.

diagram

It has now become a fully matured time-tested API able to hide almost entirely communication complexity with these providers by this series of steps:

API is fully PSR-4 compliant, only requiring PHP 8.1+ interpreter, Lucinda URL Requester and SimpleXML extension. To quickly see how it works, check:

  • installation: describes how to install API on your computer, in light of steps above
  • UnitTest API instead of PHPUnit for greater flexibility
  • Lucinda\OAuth2\Wrapper

Registration

OAuth2 requires your site (the client) to be available on world-wide-web in order to communicate with provider (the server). To do so your site must be registered on provider's site, same way as a user would! Registration endpoints for supported providers are:

Once you land there you will be asked on registration to fill a form in which you will need to supply:

  • redirect_uri: (always) complete link to your site where OAUTH2 vendor should redirect authorization code to
  • scopes: (sometimes) rights specific to vendor your site require on each site client's account
  • application_name: (only by GitHub) unique name that identifies your site against others

Once registered, your site will get:

  • client_id: public id that identifies your site on OAUTH2 vendor site
  • client_secret: private key associated to your site on OAUTH2 vendor site, to use in authorization code - access token exchange

To learn more how each of them work, check specialized article

Configuration

To configure this API you must have a XML with following tag:

Where:

  • oauth2: (mandatory) holds global oauth2 settings.
    • {ENVIRONMENT}: name of development environment (to be replaced with "local", "dev", "live", etc)
      • driver: stores information about a single oauth2 provider via attributes:
        • name: (mandatory) name of OAuth2 provider. Can be: Facebook, GitHub, Google, LinkedIn, Instagram, VK, Yahoo, Yandex!
        • client_id: (mandatory) public id that identifies your site on OAUTH2 vendor site (see: registration)
        • client_secret: (mandatory) private key associated to your site on OAUTH2 vendor site, to use in authorization code - access token exchange (see: registration)
        • callback: (mandatory) relative uri (page) in your site where OAUTH2 vendor should redirect authorization code to (see: registration). Must be unique!
        • scopes: (optional) rights levels on client's vendor account your site require (see: registration)
        • {OPTIONS}: a list of extra attributes not part of specifications but required by certain providers:
          • application: (mandatory if provider = GitHub) name of your site (see: registration)

Example:

Execution

Initialization

Now that XML is configured, you can get driver whose login uri matches requested page by querying Lucinda\OAuth2\Wrapper:

Driver returned is a Lucinda\OAuth2Client\Driver instance, each corresponding to a "driver" tag whose callback matches requested page, each hiding complexity of vendor underneath through a common interface centered on oauth2 client operations. If no driver is found matching requested page, NULL is returned!

NOTE: because XML parsing is somewhat costly, it is recommended to save $object somewhere and reuse it throughout application lifecycle.

Querying Provider

Once you obtain a driver, you able to query it automatically. First however you need to obtain an access token from provider in controller that handles all REDIRECT_URI (since this logic is same across vendors):

Once an access token is saved you can use it in current or future requests to authenticate resources requests on vendor. Before using it, you need to make sure token has not expired:

Then to retrieve any resource on vendor whose scope was approved by client:

Example

Assuming driver is:

If value of $_SERVER["REQUEST_URI"] is "login/facebook", in line of Querying Provider above, first a check is made if "code" querystring param is present:

  • NO: redirects to provider and asks client to approve access for public_profile and email visualization rights. If approved, vendor redirects to same page but with a "code" param
  • YES: asks provider to exchange short lived authorization code (value of "code" param) with a long lived access token

Now that access token is obtained, developers can use it to retrieve public_profile and email information about client from vendor site:

Installation

First choose a folder, associate it to a domain then write this command there using console:

Then create a configuration.xml file holding configuration settings (see initialization in project root with following code:

Then make sure domain is available to world-wide-web and all request that point to it are rerouted to index.php:

Unit Tests

For tests and examples, check following files/folders in API sources:

All versions of oauth2-client with dependencies

PHP Build Version
Package Version
Requires php Version ^8.1
ext-simplexml Version *
lucinda/requester Version ^2.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package lucinda/oauth2-client contains the following files

Loading the files please wait ....