README

SimplesamlPHP module for IRMA authentication

Introduction

This module for simpleSAMLphp allows easy integration of IRMA authentication into an existing simpleSAMLphp setup. This document explains how to install the simpleSAMLphp module and how to configure it.

We are going to assume you have a working simpleSAMLphp installation. If you don't, refer to the documentation of simpleSAMLphp itself.

Installing the module and required libraries

Install using composer

To install in simplesamlphp, use the composer-based simplesamlphp module installer

composer require irma/simplesamlphp-module-authirma

Manual install

Download the latest version of the simpleSAMLphp IRMA module.

Install the module in the modules/ directory of your simpleSAMLphp setup (or symlink it if you want to keep the directory structure clean). The module is enabled by default: no need for a 'touch enable' inside the module directory.

Note that authirma depends on php-jwt for encoding and decoding JSON Web Tokens (JWT). Install using composer:

composer require firebase/php-jwt

Configuration

See docs /docs/authirma.md for configuration instructions.

Quickstart

Install simplesamlphp

git clone https://github.com/simplesamlphp/simplesamlphp.git
cd simplesamlphp/

Install the IRMA authentication module

composer require irma/simplesamlphp-module-authirma

Copy sample configuration files

cp config-templates/config.php config-templates/authsources.php config

Edit config/config.php to change the following:

'baseurlpath' => '',

Edit config/authsources.php and add an authentication source named irma of type authirma:IRMA. See docs/authirma.

Create a directory for storing certificates and keys:

mkdir -p cert

Put the private key for signing JWT requests and the certificate with the public key of the API server in the cert directory.

Start a PHP web server:

php -S 0:8080 -t www

Point your browser to http://localhost:8080/

irma / simplesamlphp-module-authirma

Maintainers

Details