Class: VerifyVspClient::ServiceProvider

Inherits:
Object
  • Object
show all
Defined in:
lib/verify_vsp_client/service_provider.rb

Overview

Interface for interacting with an instance of a Verify Service Provider.

Make sure the VSP host is configured, for example:

VerifyVspClient.configuration.vsp_host= "https://vsp.host:50300"

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.generate_request_url ⇒ Object 



10
11
12
 
# File 'lib/verify_vsp_client/service_provider.rb', line 10

def self.generate_request_url
  "#{VerifyVspClient.configuration.vsp_host}/generate-request"
end

.translate_response_url ⇒ Object 



14
15
16
 
# File 'lib/verify_vsp_client/service_provider.rb', line 14

def self.translate_response_url
  "#{VerifyVspClient.configuration.vsp_host}/translate-response"
end

Instance Method Details

#generate_request ⇒ Object

Makes a request to the Verify Service Provider to generate an authentication request, as described here:

https://www.docs.verify.service.gov.uk/get-started/set-up-successful-verification-journey/#generate-an-authentication-request

The authentication request is used to start the identity assurance process with Verify.

Returns the authentication request as a Hash, for example:

{
  "samlRequest" => "PD94bWwgdmVyc2lvbj0iMS4wIiBlb...",
  "requestId" => "_f43aa274-9395-45dd-aaef-25f56fe",
  "ssoLocation" => "https://compliance-tool-reference.ida.digital.cabinet-office.gov.uk/SAML2/SSO"
}

Raises VerifyVspClient::ResponseError if the VSP responds with an error response.



35
36
37
38
39
40
41
42
 
# File 'lib/verify_vsp_client/service_provider.rb', line 35

def generate_request
  uri = URI(self.class.generate_request_url)
  request = Net::HTTP::Post.new(uri, {})
  request.content_type = "application/json"
  response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri_uses_ssl?(uri)) { |http| http.request(request) }

  handle_response response.body
end

#translate_response(saml_response, request_id, level_of_assurance) ⇒ Object

Makes a request to the Verify Service Provider to translate a SAML response returned by Verify, as described here:

https://www.docs.verify.service.gov.uk/get-started/set-up-successful-verification-journey/#request-to-translate-the-saml-response

The SAML response is the payload representing the result of the Verify identity assurance attempt by the user.

Returns the translated response as a Hash, for example:

{
    "scenario" => "IDENTITY_VERIFIED",
    "pid" => "etikgj3ewowe",
    "levelOfAssurance" => "LEVEL_2",
    "attributes" => {...}
}

Raises VerifyVspClient::ResponseError if the VSP responds with an error response.



62
63
64
65
66
67
68
69
70
 
# File 'lib/verify_vsp_client/service_provider.rb', line 62

def translate_response(saml_response, request_id, level_of_assurance)
  uri = URI(self.class.translate_response_url)
  request = Net::HTTP::Post.new(uri)
  request.body = {"samlResponse" => saml_response, "requestId" => request_id, "levelOfAssurance" => level_of_assurance}.to_json
  request.content_type = "application/json"
  response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri_uses_ssl?(uri)) { |http| http.request(request) }

  handle_response response.body
end