Download the PHP package phantomwatson/cakephp-simple-saml without Composer

SimpleSaml plugin for CakePHP

Installation

Until this issue is resolved, SimpleSAML is incompatible with CakePHP's Bake package, so cakephp/bake must be removed before installing.

Then:

Add an authorization policy

• Add an authorization policy class under /src/Policy. (example policy)

Update Application.php

• Have the Application class implement AuthorizationServiceProviderInterface

• Add these lines to Application::bootstrap():

• Add getAuthorizationService() and getAuthenticationService() methods, using the name of your policy class:

  • Set the value of tokenField to the name of the database field to identify users with (e.g. 'sso-uuid')
  • Set the value of dataField to the name of the field in the data received from the authenticator (e.g. 'id')

Update AppController.php

In AppController::initialize(), load the SimpleSamlComponent from the plugin:

Uncomment and change the value of authSource if needed.

Update User model

Have User entity class implement IdentityInterface and add the getIdentifier() and getOriginalData() methods to it. (example)

Get SimpleSAML's /www directory ready for being accessed

1. Set up a VirtualHost alias (or its equivalent in non-Apache servers) or a symlink for /vendor/simplesamlphp/simplesamlphp/www, named something like /simplesaml
2. Navigate to /vendor/simplesamlphp/simplesamlphp in the command line and run these two commands to download front-end dependencies and set up CSS and JS (this assumes that NodeJS is installed on the server).

Configuration

1. Copy the SimpleSAML /config-templates directory to /config/simplesaml at the root of the project
2. Set the SIMPLESAMLPHP_CONFIG_DIR environment variable to the path to this new directory so SimpleSAML can access these config files.
   • If you're doing this via PHP, you would use putenv('SIMPLESAMLPHP_CONFIG_DIR=' . CONFIG . 'simplesaml');
   • Do not include a trailing slash in the path string
   • This can be placed in /config/bootstrap.php
3. Set baseurlpath value to the full URL path to access SimpleSAML's www directory, e.g. 'baseurlpath' => 'https://example.com/simplesaml-alias-name/'
4. If SimpleSAML's metadata files need to be edited
   1. Copy the library's /metadata-templates directory to /config/simplesaml/metadata from the project's root
   2. Update the metadatadir value in /config/simplesaml/config.php

Run checks

Open the SimpleSAML web-accessible directory in a browser to confirm that it’s installed and configured correctly.

Using the component

All controllers should now have access to the SimpleSaml component, which provides these methods:

• $this->SimpleSaml->isAuthenticated(); - Returns true if the user is logged in via SimpleSaml
• $this->SimpleSaml->login($params); - Starts the authentication process ($params is documented at \SimpleSAML\Auth\Simple::login())
• $this->SimpleSaml->logout(); - Logs the user out
• $this->SimpleSaml->getUserAttributes(); - Returns the authenticated user's attributes from the SimpleSaml session, or an empty array if no user is authenticated