oauth2-server/installation.md

layout	title	permalink
default	Installation	/installation/

Installation

The recommended installation method is using Composer.

In your project root just run:

{% highlight shell %} composer require league/oauth2-server:5.0.0-RC2 {% endhighlight %}

Ensure that you’ve set up your project to autoload Composer-installed packages.

Depending on which grant you are implementing you will need to implement a number of repository interfaces. Each grant documentation page lists which repositories are required, and each repository interface has it's own documentation page.

The repositories are expected to return (on success) instances of entity interfaces; to make integration with your existing entities and models as easy as possible though, all required methods have been implemented as traits that you can use.

Generating public and private keys

To generate the private key run this command on the terminal:

{% highlight shell %} openssl genrsa -out private.key 1024 {% endhighlight %}

If you want to provide a passphrase for your private key run this command instead:

{% highlight shell %} openssl genrsa -passout pass:passphrase -out private.key 1024 {% endhighlight %}

then extract the public key from the private key:

{% highlight shell %} openssl rsa -in private.key -pubout -out public.key {% endhighlight %}

or use your passphrase if provided on private key generation:

{% highlight shell %} openssl rsa -in private.key -passin pass:passphrase -pubout -out public.key {% endhighlight %}

The private key must be kept secret (i.e. out of the web-root of the authorization server). The authorization server also requires the public key.

If a passphrase has been used to generate private key it must be provided to the authorization server.

The public key should be distributed to any services (for example resource servers) that validate access tokens.