The goal of the Verify Hub Architecture is to provide a long term flexible and scalable solution for GOV.UK Verify. In order to achieve this, the system is a Service Oriented Architecture(SOA) using REST and principles borrowed from the concept of microservices.
The system is divided into logical microservices – with one or more services that provide the functionality required to implement the Hub SAML Profile. Some of the separation is due to logical differences between the components, while other separation is base on security aspects of the service. The eventual goal for this system is for each of these components to be independently deployable and live in separate code bases.
- Frontend Services: verify-frontend
- Proxy Services: saml-proxy, saml-soap-proxy
- Business Services: config, saml-engine, policy
- Stub Services: stub-idp, test-rp,
- Private Beta Support: token-service
- Hub Support Services: event-sink, audit, billing
- Relying Party Support: matching-service-adapter (MSA), verify-service-provider (VSP)
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
This repository contains the core Verify Hub microservices (README files for each are linked below):
When running hub locally stub-event-sink is used in place of event-sink in ida-hub-support
The following software is required (installation notes follow)
- Java 8 JDK (Oracle)
- Git
- Gradle
- Intellij Community (Ultimate is fine as well)
- Node.js
- Ruby, with rbenv
- 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}
Either install Gradle, or use gradle wrapper
-
Option 1 - Install Gradle (ensure that you have gradle 4.0)
- 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
- Linux (Ubuntu)
Due to an ubuntu package name conflict, node was renamed to nodejs in apt
sudo apt-get install nodejs
Create symlink to restore original command name
ln -s /usr/bin/nodejs /usr/bin/node
There are some build scripts within the hub project that use ruby, plus you'll require Ruby in order to use verify-puppet (Puppet and ops tools) and the verify-boxes (infrastructure as code: VMs, firewalls, VPNs etc) repo.
To avoid polluting your system ruby installation and to allow switching between different Ruby versions, you should install rbenv and then use that to install Rubies.
Install homebrew if you haven't already, then brew install rbenv
You probably want to follow the instructions to install rbenv and ruby-build
rbenv global 2.4.2
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
From root core hub directory: (replace gradle with ./gradlew if using gradle wrapper)
Run the build
gradle build
Setup IntelliJ Project files
gradle idea
Run pre-commit script (build, unit test, package)
./pre-commit.sh
To spin up hub services to test on your local machine
./startup.sh
To spin up all services in the Verify federation, clone verify-local-startup as a sibling of verify-hub
cd ../verify-local-startup
./startup.sh
If you think you have discovered a security issue in this code please email disclosure@digital.cabinet-office.gov.uk with details.
For non-security related bugs and feature requests please raise an issue in the GitHub issue tracker.
This project is developed under the Alphagov Code of Conduct