Class: OneLogin::RubySaml::SloLogoutresponse

Inherits:
SamlMessage
  • Object
show all
Defined in:
lib/onelogin/ruby-saml/slo_logoutresponse.rb

Overview

SAML2 Logout Response (SLO SP initiated, Parser)

Constant Summary

Constants inherited from SamlMessage

OneLogin::RubySaml::SamlMessage::ASSERTION, OneLogin::RubySaml::SamlMessage::BASE64_FORMAT, OneLogin::RubySaml::SamlMessage::PROTOCOL

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from SamlMessage

#id, schema, #valid_saml?, #version

Constructor Details

#initializeSloLogoutresponse

Initializes the Logout Response. A SloLogoutresponse Object that is an extension of the SamlMessage class. Asigns an ID, a random uuid.


21
22
23
# File 'lib/onelogin/ruby-saml/slo_logoutresponse.rb', line 21

def initialize
  @uuid = OneLogin::RubySaml::Utils.uuid
end

Instance Attribute Details

#uuidObject (readonly)

Logout Response ID


16
17
18
# File 'lib/onelogin/ruby-saml/slo_logoutresponse.rb', line 16

def uuid
  @uuid
end

Instance Method Details

#create(settings, request_id = nil, logout_message = nil, params = {}) ⇒ String

Creates the Logout Response string.

Parameters:

  • settings (OneLogin::RubySaml::Settings|nil)

    Toolkit settings

  • request_id (String) (defaults to: nil)

    The ID of the LogoutRequest sent by this SP to the IdP. That ID will be placed as the InResponseTo in the logout response

  • logout_message (String) (defaults to: nil)

    The Message to be placed as StatusMessage in the logout response

  • params (Hash) (defaults to: {})

    Some extra parameters to be added in the GET for example the RelayState

Returns:

  • (String)

    Logout Request string that includes the SAMLRequest


32
33
34
35
36
37
38
39
40
41
42
43
# File 'lib/onelogin/ruby-saml/slo_logoutresponse.rb', line 32

def create(settings, request_id = nil, logout_message = nil, params = {})
  params = create_params(settings, request_id, logout_message, params)
  params_prefix = (settings.idp_slo_target_url =~ /\?/) ? '&' : '?'
  saml_response = CGI.escape(params.delete("SAMLResponse"))
  response_params = "#{params_prefix}SAMLResponse=#{saml_response}"
  params.each_pair do |key, value|
    response_params << "&#{key.to_s}=#{CGI.escape(value.to_s)}"
  end

  raise SettingError.new "Invalid settings, idp_slo_target_url is not set!" if settings.idp_slo_target_url.nil? or settings.idp_slo_target_url.empty?
  @logout_url = settings.idp_slo_target_url + response_params
end

#create_logout_response_xml_doc(settings, request_id = nil, logout_message = nil) ⇒ String

Creates the SAMLResponse String.

Parameters:

  • settings (OneLogin::RubySaml::Settings|nil)

    Toolkit settings

  • request_id (String) (defaults to: nil)

    The ID of the LogoutRequest sent by this SP to the IdP. That ID will be placed as the InResponseTo in the logout response

  • logout_message (String) (defaults to: nil)

    The Message to be placed as StatusMessage in the logout response

Returns:

  • (String)

    The SAMLResponse String.


101
102
103
104
# File 'lib/onelogin/ruby-saml/slo_logoutresponse.rb', line 101

def create_logout_response_xml_doc(settings, request_id = nil, logout_message = nil)
  document = create_xml_document(settings, request_id, logout_message)
  sign_document(document, settings)
end

#create_params(settings, request_id = nil, logout_message = nil, params = {}) ⇒ Hash

Creates the Get parameters for the logout response.

Parameters:

  • settings (OneLogin::RubySaml::Settings|nil)

    Toolkit settings

  • request_id (String) (defaults to: nil)

    The ID of the LogoutRequest sent by this SP to the IdP. That ID will be placed as the InResponseTo in the logout response

  • logout_message (String) (defaults to: nil)

    The Message to be placed as StatusMessage in the logout response

  • params (Hash) (defaults to: {})

    Some extra parameters to be added in the GET for example the RelayState

Returns:

  • (Hash)

    Parameters


52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
# File 'lib/onelogin/ruby-saml/slo_logoutresponse.rb', line 52

def create_params(settings, request_id = nil, logout_message = nil, params = {})
  # The method expects :RelayState but sometimes we get 'RelayState' instead.
  # Based on the HashWithIndifferentAccess value in Rails we could experience
  # conflicts so this line will solve them.
  relay_state = params[:RelayState] || params['RelayState']

  if relay_state.nil?
    params.delete(:RelayState)
    params.delete('RelayState')
  end

  response_doc = create_logout_response_xml_doc(settings, request_id, logout_message)
  response_doc.context[:attribute_quote] = :quote if settings.double_quote_xml_attribute_values

  response = ""
  response_doc.write(response)

  Logging.debug "Created SLO Logout Response: #{response}"

  response = deflate(response) if settings.compress_response
  base64_response = encode(response)
  response_params = {"SAMLResponse" => base64_response}

  if settings.security[:logout_responses_signed] && !settings.security[:embed_sign] && settings.private_key
    params['SigAlg']    = settings.security[:signature_method]
    url_string = OneLogin::RubySaml::Utils.build_query(
      :type => 'SAMLResponse',
      :data => base64_response,
      :relay_state => relay_state,
      :sig_alg => params['SigAlg']
    )
    sign_algorithm = XMLSecurity::BaseDocument.new.algorithm(settings.security[:signature_method])
    signature = settings.get_sp_key.sign(sign_algorithm.new, url_string)
    params['Signature'] = encode(signature)
  end

  params.each_pair do |key, value|
    response_params[key] = value.to_s
  end

  response_params
end

#create_xml_document(settings, request_id = nil, logout_message = nil) ⇒ Object


106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
# File 'lib/onelogin/ruby-saml/slo_logoutresponse.rb', line 106

def create_xml_document(settings, request_id = nil, logout_message = nil)
  time = Time.now.utc.strftime('%Y-%m-%dT%H:%M:%SZ')

  response_doc = XMLSecurity::Document.new
  response_doc.uuid = uuid

  root = response_doc.add_element 'samlp:LogoutResponse', { 'xmlns:samlp' => 'urn:oasis:names:tc:SAML:2.0:protocol', "xmlns:saml" => "urn:oasis:names:tc:SAML:2.0:assertion" }
  root.attributes['ID'] = uuid
  root.attributes['IssueInstant'] = time
  root.attributes['Version'] = '2.0'
  root.attributes['InResponseTo'] = request_id unless request_id.nil?
  root.attributes['Destination'] = settings.idp_slo_target_url unless settings.idp_slo_target_url.nil? or settings.idp_slo_target_url.empty?

  if settings.sp_entity_id != nil
    issuer = root.add_element "saml:Issuer"
    issuer.text = settings.sp_entity_id
  end

  # add success message
  status = root.add_element 'samlp:Status'

  # success status code
  status_code = status.add_element 'samlp:StatusCode'
  status_code.attributes['Value'] = 'urn:oasis:names:tc:SAML:2.0:status:Success'

  # success status message
  logout_message ||= 'Successfully Signed Out'
  status_message = status.add_element 'samlp:StatusMessage'
  status_message.text = logout_message

  response_doc
end

#sign_document(document, settings) ⇒ Object


139
140
141
142
143
144
145
146
147
148
# File 'lib/onelogin/ruby-saml/slo_logoutresponse.rb', line 139

def sign_document(document, settings)
  # embed signature
  if settings.security[:logout_responses_signed] && settings.private_key && settings.certificate && settings.security[:embed_sign]
    private_key = settings.get_sp_key
    cert = settings.get_sp_cert
    document.sign_document(private_key, cert, settings.security[:signature_method], settings.security[:digest_method])
  end

  document
end