verify-hub

GOV.UK Verify has closed

This repository is out of date and has been archived

Verify-hub contains the source code for some of the core components of the GOV.UK Verify Hub:

• policy
• config
• saml-proxy
• saml-soap-proxy
• config

The frontend is located here.

An technical overview of the Hub is available here.

Architectural Descision Records and documentation

We record our architectural decisions in doc/adr. We use adr-tools to help manage these decisions.

Answers to some questions can be found on the hub wiki

Prerequisites

The following software is required (installation notes follow)

1. Java 11 JDK (OpenJDK)
2. Git
3. Gradle
4. Intellij Community (Ultimate is fine as well)

Java 11 JDK (OpenJDK)

• Mac:

Get Installable from: http://www.oracle.com/technetwork/java/javase/downloads/index.html
Once Installed Set JAVA_HOME Environment Variable (required by Gradle)
Example: In mac add line to .bash_profile:
export JAVA_HOME='/Library/Java/JavaVirtualMachines/{your jdk version}/Contents/Home/'

• Linux:

Detailed installation instructions can be found on Stack Overflow:
http://askubuntu.com/questions/56104/how-can-i-install-sun-oracles-proprietary-java-jdk-6-7-8-or-jre
Set JAVA_HOME environment variable in .bash_profile or similar (required by Gradle):
export JAVA_HOME=/usr/lib/jvm/{your-jdk-version}

Gradle

Either install Gradle, or use gradle wrapper

• Option 1 - Install Gradle (ensure that you have gradle 6.0.1)

  • Mac: using homebrew

brew install gradle

• Linux:

Manual install: http://www.gradle.org/downloads
Extract from zip, add gradle /bin directory to PATH environment variable in .bash_profile or similar.

• Option 2 - Use Gradle Wrapper The core hub repo contains an instance of Gradle Wrapper which can be used straight from here without further installation. To use, call the ./gradlew script from core hub's root directory

Configuration

Gradle

The hub build.gradle runs a parallel build. The number of parallel forks used when running integration tests can be configured by setting the environment variable ORG_GRADLE_PROJECT_IDA_HUB_MAX_PARALLEL_FORKS (defaults to number of cores if not set). For example:

export ORG_GRADLE_PROJECT_IDA_HUB_MAX_PARALLEL_FORKS=4

Start Development

From root core hub directory: (replace gradle with ./gradlew if using gradle wrapper)

Run the build

gradle build

Setup IntelliJ Project files

gradle idea

Before Committing

Run pre-commit script (build, unit test, package)

./pre-commit.sh

Running Locally

To spin up hub services to test on your local machine

./startup.sh

To spin up all services in the Verify federation, clone ida-hub-acceptance-tests as a sibling of verify-hub

cd ../ida-hub-acceptance-tests
./hub-startup.sh

Support and raising issues

If you think you have discovered a security issue in this code please email [email protected] with details.

For non-security related bugs and feature requests please raise an issue in the GitHub issue tracker.

Code of Conduct

This project is developed under the Alphagov Code of Conduct