con4gis/oauth

Authentication bundle with functionality needed for authenticating with OpenID Connect

v1.0.2 2022-02-02 17:25 UTC

This package is auto-updated.

Last update: 2022-05-18 14:38:02 UTC


README

This bundle adds OAuth Authentication functionality for Contao frontend users. In addition, you can also make the entire frontend accessible exclusively via an upstream login.

Currently this bundle only supports OpenID Connect Servers.

Installation

Step 1: Install the bundle

You can install the bundle using composer or the contao manager. For composer use the following command:

$ composer require con4gis/oauth

In the contao manager, you can find the bundle under "con4gis/oauth".

Step 2: Configure the bundle

After the installation you need to configure the app under config/config.yml.

OpenID-Connect:

parameters:
  con4gis.oauth.oidc.client_id: "### The client id for the openid connect server ###"
  con4gis.oauth.oidc.client_secret: "### The client secret for the openid connect server ###"
  con4gis.oauth.oidc.auth_server_url: "### The authentication url for the openid connect server ###"
  con4gis.oauth.oidc.realm: "### The realm for the openid connect server ####"
  # Uncomment the following option if you want to access the entire frontend via an upstream login
  #con4gis.oauth.oidc.secured: "true"

Step 3: Clear the cache

You can now clear the cache via the contao manager or the contao console:

$ php vendor/bin/contao-console cache:clear -e prod

Step 4: Configure the login module

This step is only necessary if you don't make the entire frontend accessible via an upstream login.

In the contao backend you can create the new OAuth login module. There you can set up, which groups will be assigned to new logins and which user data will be stored in the contao database. The username is saved by default.

The module creates a new login button, that you can place anywhere on your site.

Callback URLs

To be able to login successfully you need to allow the following callback urls in your OAuth Application:

OAuth Provider Callback URL
OpenID Connect http://your-domain/oidc/callback