Stepup Gateway
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
app
bin
docs
src/Surfnet/StepupGateway
web
.gitignore
.scrutinizer.yml
.travis.php.ini
.travis.yml
CHANGELOG.md
LICENSE
README.md
app_dev.php.dist
app_test.php.dist
build.xml
composer.json
composer.lock
phpcs.xml
phpmd-pre-commit.xml
phpmd.xml

README.md

Step-up Gateway

Build Status Scrutinizer Code Quality SensioLabsInsight

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

  • PHP 5.6 (Note that we test on 7.0 but do not run or support it officially)
  • Composer
  • A web server (Apache, Nginx)
  • MariaDB 5.5+ (MySQL should work as well)
  • syslog (or change the logging configuration in /app/config/logging.yml)

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 for u2f using app/console u2f:migrations:migrate.

Run app/console mopa:bootstrap:symlink:less to configure Bootstrap symlinks.

The Gateway is configured to only accept connections over SSL. Disable this under nelmio_security in config.yml or run the web server using a (self-signed) certificate.

Developer options

Mock Yubikey service

If you are not in possession of an actual Yubikey device, using the Mock Yubikey service might prove useful. This mock service was created for end to end test purposes, but could be utilized in this situation. To use the mock service:

  1. Update your src/Surfnet/StepupGateway/ApiBundle/Resources/config/services.yml
  2. Find the surfnet_gateway_api.service.yubikey service
  3. Update the service definition to point to this class: class: Surfnet\StepupGateway\ApiBundle\Tests\TestDouble\Service\YubikeyService
  4. Do not commit/push this change!

Release strategy

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

Documentation

Documentation specific to this component is located in the docs directory in this repository:

Documentation for the Stepup system can be found in the