How SAML works with GOV.UK Verify¶
SAML messages take the form of requests and responses. Messages can contain assertions about the user’s identity. GOV.UK Verify uses the following types of assertion:
- identity assertions – contain information about the user
- authentication context assertions – contain information related to how authentication was carried out, for example, the level of assurance
- fraud event assertions – contain identifiers related to an identified fraud detected by the identity provider
The SAML profile defines these assertions. See the list of documents defining the SAML profile.
All SAML messages that pass between the government service, the hub, and identity providers are sent via the user’s browser.
This diagram shows the SAML message flow within the GOV.UK Verify federation. The numbers identify each stage in the flow. See below for explanations.
For more details, see: |
- The user initiates the Verify process from their browser when they request to log into the government service.
- The government service sends a JSON authentication request to the Verify Service Provider (VSP). The VSP converts the JSON request into a SAML authentication request.
- The VSP sends the SAML authentication request back to the government service. The government service then signs the SAML request and forwards it to the GOV.UK Verify hub. The request shows that a user wants to access the government service and needs to prove their identity using GOV.UK Verify.
- The GOV.UK Verify hub prompts the user to select an identity provider to authenticate them. The GOV.UK Verify hub anonymises the government service and forwards the SAML authentication request to the identity provider the user chose. The identity provider authenticates the user based on the required level of assurance
- The identity provider then signs and sends a SAML response to the GOV.UK Verify hub. The SAML response contains an authentication context assertion and an identity assertion, both signed by the identity provider and encrypted for the GOV.UK Verify hub. The authentication context assertion validates the user’s authentication and contains the level of assurance. The identity assertion contains the user’s matching dataset and the persistent identifier.
To learn more about the contents of the assertions, see matching cycles and user account creation.
- The GOV.UK Verify hub signs and sends a SAML attribute query to the government service’s Matching Service Adapter. The SAML attribute query is encrypted for the Matching Service Adapter and contains the identity assertion signed by the identity provider.
- The Matching Service Adapter anonymises the identity provider, translates the SAML attribute query into a JSON matching request, and forwards it to the service’s Local Matching Service. The Local Matching Service tries to match the user with a record in the government service’s database.
- The Local Matching Service returns a
match
orno-match
JSON response to the Matching Service Adapter. - If the response is
match
, the Matching Service Adapter translates the JSON response into a SAML attribute query response, signs it, and forwards it to the GOV.UK Verify hub. The attribute query response contains an assertion signed by the Matching Service Adapter and encrypted for the GOV.UK Verify hub. The assertion contains the hashed persistent identifier, the ID of the matched record from the government service database, and level of assurance.
- The GOV.UK Verify hub signs and sends a SAML response to the government service, completing user authentication. The SAML response contains an assertion signed by the Matching Service Adapter and is encrypted for the government service. The government service forwards it to the VSP for verification and translation to JSON.
- The VSP returns a JSON response to the government service, forarding the record ID for the matched identity.
- The government service gets the user’s record from the datastore based on the record ID. This allows the government service to interact with the user.