Class: SamlIdp::IncomingMetadata

Inherits:
Object
  • Object
show all
Includes:
Hashable
Defined in:
lib/saml_idp/incoming_metadata.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Hashable

#hashables, #to_h

Constructor Details

#initialize(raw = "") ⇒ IncomingMetadata

Returns a new instance of IncomingMetadata.



11
12
13
# File 'lib/saml_idp/incoming_metadata.rb', line 11

def initialize(raw = "")
  self.raw = raw
end

Instance Attribute Details

#rawObject

Returns the value of attribute raw.



6
7
8
# File 'lib/saml_idp/incoming_metadata.rb', line 6

def raw
  @raw
end

Instance Method Details

#assertion_consumer_servicesObject



116
117
118
119
120
121
122
123
124
125
# File 'lib/saml_idp/incoming_metadata.rb', line 116

def assertion_consumer_services
  xpath(
    "//md:SPSSODescriptor/md:AssertionConsumerService",
    md: 
  ).sort_by { |el| el["index"].to_i }.reduce([]) do |array, el|
    props = el["Binding"].to_s.match /urn:oasis:names:tc:SAML:(?<version>\S+):bindings:(?<name>\S+)/
    array << { binding: props[:name], location: el["Location"], default: !!el["isDefault"] }
    array
  end
end

#companyObject



136
137
138
# File 'lib/saml_idp/incoming_metadata.rb', line 136

def company
  contact_person_document.xpath("//md:Company", md: ).first.try(:content).to_s
end

#contact_personObject



55
56
57
58
59
60
61
62
63
# File 'lib/saml_idp/incoming_metadata.rb', line 55

def contact_person
  {
    given_name: given_name,
    surname: surname,
    company: company,
    telephone_number: telephone_number,
    email_address: email_address
  }
end

#contact_person_documentObject



160
161
162
# File 'lib/saml_idp/incoming_metadata.rb', line 160

def contact_person_document
  @contact_person_document ||= (xpath("//md:ContactPerson", md: ).first || Saml::XML::Document.new)
end

#display_nameObject



50
51
52
# File 'lib/saml_idp/incoming_metadata.rb', line 50

def display_name
  role_descriptor_document.present? ? role_descriptor_document["ServiceDisplayName"] : ""
end

#documentObject



15
16
17
# File 'lib/saml_idp/incoming_metadata.rb', line 15

def document
  @document ||= Saml::XML::Document.parse raw
end

#email_addressObject



144
145
146
# File 'lib/saml_idp/incoming_metadata.rb', line 144

def email_address
  contact_person_document.xpath("//md:EmailAddress", md: ).first.try(:content).to_s.gsub("mailto:", "")
end

#encryption_certificateObject



84
85
86
87
88
89
90
# File 'lib/saml_idp/incoming_metadata.rb', line 84

def encryption_certificate
  xpath(
    "//md:SPSSODescriptor/md:KeyDescriptor[@use='encryption']/ds:KeyInfo/ds:X509Data/ds:X509Certificate",
    ds: signature_namespace,
    md: 
  ).first.try(:content).to_s
end

#entity_idObject



19
20
21
# File 'lib/saml_idp/incoming_metadata.rb', line 19

def entity_id
  xpath('//md:EntityDescriptor/@entityID', md: ).first.try(:content).to_s
end

#given_nameObject



128
129
130
# File 'lib/saml_idp/incoming_metadata.rb', line 128

def given_name
  contact_person_document.xpath("//md:GivenName", md: ).first.try(:content).to_s
end

#idp_descriptor_documentObject



156
157
158
# File 'lib/saml_idp/incoming_metadata.rb', line 156

def idp_descriptor_document
  @idp_descriptor ||= xpath("//md:IDPSSODescriptor", md: ).first
end

#name_id_formatsObject



104
105
106
107
108
109
110
111
112
113
# File 'lib/saml_idp/incoming_metadata.rb', line 104

def name_id_formats
  xpath(
    "//md:SPSSODescriptor/md:NameIDFormat",
    md: 
  ).reduce(Set.new) do |set, el|
    props = el.content.to_s.match /urn:oasis:names:tc:SAML:(?<version>\S+):nameid-format:(?<name>\S+)/
    set << props[:name].to_s.underscore if props[:name].present?
    set
  end
end

#role_descriptor_documentObject



148
149
150
# File 'lib/saml_idp/incoming_metadata.rb', line 148

def role_descriptor_document
  @role_descriptor ||= xpath("//md:RoleDescriptor", md: ).first
end

#service_provider_descriptor_documentObject



152
153
154
# File 'lib/saml_idp/incoming_metadata.rb', line 152

def service_provider_descriptor_document
  @service_provider_descriptor ||= xpath("//md:SPSSODescriptor", md: ).first
end

#sign_assertionsObject



24
25
26
27
28
29
30
31
32
33
34
# File 'lib/saml_idp/incoming_metadata.rb', line 24

def sign_assertions
  doc = xpath(
    "//md:SPSSODescriptor",
    ds: signature_namespace,
    md: 
  ).first
  if (doc && !doc['WantAssertionsSigned'].nil?)
    return doc['WantAssertionsSigned'].strip.downcase == 'true'
  end
  return false
end

#sign_authn_requestObject



37
38
39
40
41
42
43
44
45
46
47
# File 'lib/saml_idp/incoming_metadata.rb', line 37

def sign_authn_request
  doc = xpath(
    "//md:SPSSODescriptor",
    ds: signature_namespace,
    md: 
  ).first
  if (doc && !doc['AuthnRequestsSigned'].nil?)
    return doc['AuthnRequestsSigned'].strip.downcase == 'true'
  end
  return false
end

#signing_certificateObject



75
76
77
78
79
80
81
# File 'lib/saml_idp/incoming_metadata.rb', line 75

def signing_certificate
  xpath(
    "//md:SPSSODescriptor/md:KeyDescriptor[@use='signing']/ds:KeyInfo/ds:X509Data/ds:X509Certificate",
    ds: signature_namespace,
    md: 
  ).first.try(:content).to_s
end

#single_logout_servicesObject



93
94
95
96
97
98
99
100
101
# File 'lib/saml_idp/incoming_metadata.rb', line 93

def single_logout_services
  xpath(
    "//md:SPSSODescriptor/md:SingleLogoutService",
    md: 
  ).reduce({}) do |hash, el|
    hash[el["Binding"].to_s.split(":").last] = el["Location"]
    hash
  end
end

#surnameObject



132
133
134
# File 'lib/saml_idp/incoming_metadata.rb', line 132

def surname
  contact_person_document.xpath("//md:SurName", md: ).first.try(:content).to_s
end

#telephone_numberObject



140
141
142
# File 'lib/saml_idp/incoming_metadata.rb', line 140

def telephone_number
  contact_person_document.xpath("//md:TelephoneNumber", md: ).first.try(:content).to_s
end

#unspecified_certificateObject



66
67
68
69
70
71
72
# File 'lib/saml_idp/incoming_metadata.rb', line 66

def unspecified_certificate
  xpath(
    "//md:SPSSODescriptor/md:KeyDescriptor[not(@use)]/ds:KeyInfo/ds:X509Data/ds:X509Certificate",
    ds: signature_namespace,
    md: 
  ).first.try(:content).to_s
end