Adds support to SilverStripe for authentication via RealMe (https://www.realme.govt.nz/)

Installs: 22 582

Dependents: 1

Suggesters: 0

Security: 0

Stars: 5

Watchers: 11

Forks: 20

Type:silverstripe-vendormodule

4.0.0 2020-02-27 01:34 UTC

This package is auto-updated.

Last update: 2020-05-27 02:06:10 UTC


README

Build Status SilverStripe supported module Code Quality License Version

Adds support to SilverStripe for authentication and identity assertion via RealMe.

This module provides the foundation to support a quick integration for a SilverStripe application with RealMe as an identity provider. This module requires extensive setup prior to being utilised effectively.

If integration with RealMe is wanted, it is best to get in touch with the RealMe team as early as possible. This can be accomplished by getting in touch with the RealMe team.

Releases

There are multiple releases of this module. The current stable version is the 4.x line. This is a stable module that provides logon (authentication) and assert (identity assertion) capability. The 2.x line can be used for SilverStripe 3.x support. The line 3.x only works with PHP <= 7.1 and is deprecated. The older 0.9.x line is considered end of life and should not be used.

Support

Support is provided via the GitHub Issues for this module.

The 4.0.0 release has been tested with PHP 7.1, 7.2 and 7.3 for the following integrations:

  • MTS Logon
  • MTS Assert (XML)
  • ITE Logon
  • ITE Assert (JSON)

If you encounter any issues please open a new issue here.

Requirements

This module doesn't have any specific requirements beyond those required by onelogin/php-saml, the tool used to control authentication with the RealMe systems. The requirements of php-saml can be found on the module page

This module is designed to be run on a CWP instance, and there are two sets of installation instructions - one for use on CWP, and one for generic use.

Installation

The module is best installed via Composer, by adding the below to your composer.json.

    "require": {
        "silverstripe/realme": "^4"
    },

Or by running composer require silverstripe/realme ^4 in your project root.

Once installation is completed, configuration is required before this module will work - see below.

Configuration of RealMe for your application

RealMe provide two testing environments and a production environment for you to integrate with. Access to these environments is strictly controlled, and more information on these can be found on the RealMe Developers site.

See configuration.md for environment and YML configuration required before the module can be used.

Providing RealMe login buttons

By default, the module provides an Authenticator class in SilverStripe, adding a new login form. If you want to provide your own separate login form just for RealMe, then the built-in templates can help with this. They have been designed to integrate as cleanly as possible with SilverStripe templates, but it is up to you whether you use them, or roll your own.

See the templates documentation for more information on using or modifying these.

Testing for authentication

The RealMeService service object allows you to inject authentication where-ever it is required. For example, let's take a simple Controller that ensures that all users have a valid RealMe 'FLT' (a unique string that identifies a RealMe user, but is not their username):

use SilverStripe\Control\Controller;
use SilverStripe\Control\HTTPRequest;
use SilverStripe\RealMe\RealMeService;

class RealMeTestController extends Controller {
	/**
	 * @var RealMeService
	 */
	public $realMeService;

	private static $dependencies = array(
		'realMeService' => '%$SilverStripe\RealMe\RealMeService'
	);

	public function index(HTTPRequest $request) {
		// enforceLogin will redirect the user to RealMe if they're not authenticated, or return true if they are
		// authenticated with RealMe. It should only ever return 'false' if there was an error initialising config
		if($this->realMeService->enforceLogin($request)) {
			$userData = $this->realMeService->getUserData();

			printf("Congratulations, you're authenticated with a unique ID of '%s'!", $userData->SPNameID);
		} else {
			echo "There was an error while attempting to authenticate you.";
		}
	}
}

Appreciation

  • Sincere thanks to Jackson (@jakxnz) for his work reviewing and updating pull requests.