search

OpenConext / Stepup-Middleware

Stepup Middleware
Apache License 2.0
3 stars 2 forks source link

readme

Step-up Middleware

Build Status Scrutinizer Code Quality

This component is part of "Step-up Authentication as-a Service". See Stepup-Deploy for an overview and installation instructions for a complete Stepup system, including this component. The requirements and installation instructions below cover this component only.

Requirements

Installation

Clone the repository or download the archive to a directory. Install the dependencies by running composer install and fill out the database credentials et cetera.

Make sure to run database migrations using bin/console middleware:migrations:migrate.

When using 'Stepup-Deploy' the 'deploy' entity manager should be used in order to use the correct credentials e.g. bin/console middleware:migrations:migrate --em=deploy

Management API

Some of the configuration of the components is static (i.e. stored in parameteres.yml). The configuration that is expected to change during the operation of a Stepup system is managed through an API on the middleware. This provides one place and action to change the configuration and allows changing of this configuration without having to modify the configuration of several components on several servers.

Development Notes

Adding new events

Whenever adding a new event, be sure to update bin/config/events.yml. This is a list of events that is shown when replaying events. Also be sure to create or update the event serialization/deserialization tests, for example see EventSerializationAndDeserializationTest for Configuration events

Mocking time

Due to a limitation of mocking of static methods, to mock time, the helper DateTimeHelper::stubNow(DateTime $now) was created. Call ::stubNow($now) to set a fixed date/time, and call ::stubNow(null) to disable stubbing. It is recommended to run tests in a separate process when using this helper so the stub value doesn't persist between tests.

/** @runTestInSeparateProcess */
public function testItWorks()
{
    # Trick `DateTime::now()` into thinking it is 1970.
    DateTimeHelper::stubNow(new DateTime('@0'));

    $this->assertEquals('1970-01-01T00:00:00+00:00', (string) \Surfnet\Stepup\DateTime\DateTime::now());
}

Middleware vs Gateway projections

You might have seen that both the Gateway and Middleware have databases of their own. Gateway has very little knowledge of any Middleware business logic. However some data is required in Gateway for smooth operation. For example we want to verify in Gateway if an institution is whitelisted. Doing an API call for each gateway interaction would be more costly than having this data projected in the Gateway database.

At this point four Gateway projections exist. Note that they are exclusively managed by Middleware!

Results from a Middleware event might result in an update of a Gateway projection.

Creating a Gateway projection

Middleware uses Doctrine for ORM and DBAL implementation. Middleware is configured with a multi entity manager setup. Three EntityManagers (EM) are known: middleware (default), gateway and deploy. Each have a different user with each his own privileges.

Note that when you want to do an interaction on a specific EM, you need to specifically instruct Symfony/Doctrine to do so. This becomes apparent when creating and running Doctrine Migrations. Say you want to add a field to the whitelist_entry Entity. Simply running:

$ ./bin/console doctrine:migrations:diff

Does not result in a new Migration file containing the whitelist entity change. In order to get that change to show up, you need to explicitly instruct use of the correct Entity Manager.

$ ./bin/console doctrine:migrations:diff --em=gateway

The resulting migration is not yet ready to go. The migration file itself needs to be marked to use the correct database schema. The following snippet from a Migration shows how to achieve this goal.

// Excerpt from Version20220519134637
$gatewaySchema = $this->getGatewaySchema();
$this->addSql(sprintf('ALTER TABLE %s.second_factor ADD vetting_type VARCHAR(255) NOT NULL', $gatewaySchema));

Keep entities in sync

Now here comes the tricky bit. Both Gateway and Middleware have a view on the projection. Middleware writes to the gateway schema. And Gateway reads the data. Both projects utilize Doctrine to achieve those goals. Needless to say the Entity definitions for the entity in question needs to be synchronized. If they are not, weird errors may occur.

For example see this PR

Adding support for a new Generic SAML Second Factor biometric, by example

Release strategy

Please read: https://github.com/OpenConext/Stepup-Deploy/wiki/Release-Management fro more information on the release strategy used in Stepup projects.