Skip to content

KULeuven-CCIS/idp-sealer-rollover

Repository files navigation

Shibboleth IdP3 Data Sealer Rollover.

Build Status Build Status Docker Automated buil

idp-sealer-rollover is a helper program for the Open Source Shibboleth IdP 3 SAML Identity Provider.

The program does a rollover of the data sealer files and uploads them to the target servers. Its main use case is in a clustering mode when several Shibboleth IdP 3 backends share the same data sealer. Ideally it should be run from an scheduler like cron (cron file included as idp-sealer-rollover.cron).

The Shibboleth IdP 3 binaries needed to create and rollover the data sealer files are encapsulated with Docker. The size of the image is small by using Alpine Linux and only keeping the IdP files needed for the key management. Therefore, the deployment machines (not the target machines), must have Docker installed. In case you don't want to use the image on the Docker Hub, you can create your own with the Dockerfile in the /utils directory.

The idp-sealer-rollover is an executable created from the source in src/ and it includes all the dependencies (YAML::Tiny). There is no need to install the dependencies separately.

This project is hosted and used by the KU Leuven University.

Usage

idp-sealer-rollover:
Roll over Idp sealer keys using an IdP docker image, version x.x.x.
Bugs to https://github.com/nxadm/idp-sealer-rollover.

Usage:
    idp-sealer-rollover <project> <environment> [-c <configuration file>]

Parameters:
    -c|--config: configuration file
    (default: environment variable $IDP_SEALER_ROLLOVER_CONFIG)
    -h|--help:   this help info

E.g.

$ idp-sealer-rollover idp test
$ idp-sealer-rollover idp quality
$ idp-sealer-rollover idp production

Configuration

A commented configuration is included as idp-sealer-rollover.yaml.