Class: Onelogin::Saml::Response

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

Constant Summary collapse

ASSERTION = 
"urn:oasis:names:tc:SAML:2.0:assertion"
PROTOCOL = 
"urn:oasis:names:tc:SAML:2.0:protocol"
DSIG = 
"http://www.w3.org/2000/09/xmldsig#"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(response, options = {}) ⇒ Response

Returns a new instance of Response.

Raises:

  • (ArgumentError) 


16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
 
# File 'lib/onelogin/ruby-saml/response.rb', line 16

def initialize(response, options = {})
  raise ArgumentError.new("Response cannot be nil") if response.nil?
  self.options  = options
  self.response = response

  begin
    self.document = XMLSecurity::SignedDocument.new(Base64.decode64(response))
  rescue REXML::ParseException => e
    if response =~ /</
      self.document = XMLSecurity::SignedDocument.new(response)
    else
      raise e
    end
  end
end

Instance Attribute Details

#document ⇒ Object

Returns the value of attribute document.



14
15
16
 
# File 'lib/onelogin/ruby-saml/response.rb', line 14

def document
  @document
end

#options ⇒ Object

Returns the value of attribute options.



14
15
16
 
# File 'lib/onelogin/ruby-saml/response.rb', line 14

def options
  @options
end

#response ⇒ Object

Returns the value of attribute response.



14
15
16
 
# File 'lib/onelogin/ruby-saml/response.rb', line 14

def response
  @response
end

#settings ⇒ Object

Returns the value of attribute settings.



14
15
16
 
# File 'lib/onelogin/ruby-saml/response.rb', line 14

def settings
  @settings
end

Instance Method Details

#attributes ⇒ Object

A hash of alle the attributes with the response. Assuming there is only one value for each key



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/onelogin/ruby-saml/response.rb', line 50

def attributes
  @attr_statements ||= begin
    result = {}

    stmt_element = REXML::XPath.first(document, "/p:Response/a:Assertion/a:AttributeStatement", { "p" => PROTOCOL, "a" => ASSERTION })
    return {} if stmt_element.nil?

    stmt_element.elements.each do |attr_element|
      name  = attr_element.attributes["Name"]
      value = attr_element.elements.first.text

      result[name] = value
    end

    result.keys.each do |key|
      result[key.intern] = result[key]
    end

    result
  end
end

#conditions ⇒ Object

Conditions (if any) for the assertion to run



89
90
91
92
93
 
# File 'lib/onelogin/ruby-saml/response.rb', line 89

def conditions
  @conditions ||= begin
    REXML::XPath.first(document, "/p:Response/a:Assertion[@ID='#{document.signed_element_id}']/a:Conditions", { "p" => PROTOCOL, "a" => ASSERTION })
  end
end

#is_valid? ⇒ Boolean

Returns:

  • (Boolean) 


32
33
34
 
# File 'lib/onelogin/ruby-saml/response.rb', line 32

def is_valid?
  validate
end

#issuer ⇒ Object 



95
96
97
98
99
100
101
 
# File 'lib/onelogin/ruby-saml/response.rb', line 95

def issuer
  @issuer ||= begin
    node = REXML::XPath.first(document, "/p:Response/a:Issuer", { "p" => PROTOCOL, "a" => ASSERTION })
    node ||= REXML::XPath.first(document, "/p:Response/a:Assertion/a:Issuer", { "p" => PROTOCOL, "a" => ASSERTION })
    node.nil? ? nil : node.text
  end
end

#name_id ⇒ Object

The value of the user identifier as designated by the initialization request response



41
42
43
44
45
46
47
 
# File 'lib/onelogin/ruby-saml/response.rb', line 41

def name_id
  @name_id ||= begin
    node = REXML::XPath.first(document, "/p:Response/a:Assertion[@ID='#{document.signed_element_id}']/a:Subject/a:NameID", { "p" => PROTOCOL, "a" => ASSERTION })
    node ||=  REXML::XPath.first(document, "/p:Response[@ID='#{document.signed_element_id}']/a:Assertion/a:Subject/a:NameID", { "p" => PROTOCOL, "a" => ASSERTION })
    node.nil? ? nil : node.text
  end
end

#session_expires_at ⇒ Object

When this user session should expire at latest



73
74
75
76
77
78
 
# File 'lib/onelogin/ruby-saml/response.rb', line 73

def session_expires_at
  @expires_at ||= begin
    node = REXML::XPath.first(document, "/p:Response/a:Assertion/a:AuthnStatement", { "p" => PROTOCOL, "a" => ASSERTION })
    parse_time(node, "SessionNotOnOrAfter")
  end
end

#success? ⇒ Boolean

Checks the status of the response for a “Success” code

Returns:

  • (Boolean) 


81
82
83
84
85
86
 
# File 'lib/onelogin/ruby-saml/response.rb', line 81

def success?
  @status_code ||= begin
    node = REXML::XPath.first(document, "/p:Response/p:Status/p:StatusCode", { "p" => PROTOCOL, "a" => ASSERTION })
    node.attributes["Value"] == "urn:oasis:names:tc:SAML:2.0:status:Success"
  end
end

#validate! ⇒ Object 



36
37
38
 
# File 'lib/onelogin/ruby-saml/response.rb', line 36

def validate!
  validate(false)
end