Class: XMLSecurity::SignedDocument

Inherits:
BaseDocument
  • Object
show all
Includes:
OneLogin::RubySaml::ErrorHandling
Defined in:
lib/xml_security.rb

Constant Summary

Constants inherited from BaseDocument

BaseDocument::C14N, BaseDocument::DSIG, BaseDocument::NOKOGIRI_OPTIONS

Instance Attribute Summary collapse

Attributes included from OneLogin::RubySaml::ErrorHandling

#errors

Instance Method Summary collapse

Methods included from OneLogin::RubySaml::ErrorHandling

#append_error, #reset_errors!

Methods inherited from BaseDocument

#algorithm, #canon_algorithm

Constructor Details

#initialize(response, errors = []) ⇒ SignedDocument

Returns a new instance of SignedDocument.


192
193
194
195
# File 'lib/xml_security.rb', line 192

def initialize(response, errors = [])
  super(response)
  @errors = errors
end

Instance Attribute Details

#signed_element_idObject

Returns the value of attribute signed_element_id


190
191
192
# File 'lib/xml_security.rb', line 190

def signed_element_id
  @signed_element_id
end

Instance Method Details

#validate_document(idp_cert_fingerprint, soft = true, options = {}) ⇒ Object


201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
# File 'lib/xml_security.rb', line 201

def validate_document(idp_cert_fingerprint, soft = true, options = {})
  # get cert from response
  cert_element = REXML::XPath.first(
    self,
    "//ds:X509Certificate",
    { "ds"=>DSIG }
  )

  if cert_element
    base64_cert = OneLogin::RubySaml::Utils.element_text(cert_element)
    cert_text = Base64.decode64(base64_cert)
    begin
      cert = OpenSSL::X509::Certificate.new(cert_text)
    rescue OpenSSL::X509::CertificateError => e
      return append_error("Certificate Error", soft)
    end

    if options[:fingerprint_alg]
      fingerprint_alg = XMLSecurity::BaseDocument.new.algorithm(options[:fingerprint_alg]).new
    else
      fingerprint_alg = OpenSSL::Digest::SHA1.new
    end
    fingerprint = fingerprint_alg.hexdigest(cert.to_der)

    # check cert matches registered idp cert
    if fingerprint != idp_cert_fingerprint.gsub(/[^a-zA-Z0-9]/,"").downcase
      @errors << "Fingerprint mismatch"
      return append_error("Fingerprint mismatch", soft)
    end
  else
    if options[:cert]
      base64_cert = Base64.encode64(options[:cert].to_pem)
    else
      if soft
        return false
      else
        return append_error("Certificate element missing in response (ds:X509Certificate) and not cert provided at settings", soft)
      end
    end
  end
  validate_signature(base64_cert, soft)
end

#validate_document_with_cert(idp_cert) ⇒ Object


244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
# File 'lib/xml_security.rb', line 244

def validate_document_with_cert(idp_cert)
  # get cert from response
  cert_element = REXML::XPath.first(
    self,
    "//ds:X509Certificate",
    { "ds"=>DSIG }
  )

  if cert_element
    base64_cert = OneLogin::RubySaml::Utils.element_text(cert_element)
    cert_text = Base64.decode64(base64_cert)
    begin
      cert = OpenSSL::X509::Certificate.new(cert_text)
    rescue OpenSSL::X509::CertificateError => e
      return append_error("Certificate Error", soft)
    end

    # check saml response cert matches provided idp cert
    if idp_cert.to_pem != cert.to_pem
      return false
    end
  else
    base64_cert = Base64.encode64(idp_cert.to_pem)
  end
  validate_signature(base64_cert, true)
end

#validate_signature(base64_cert, soft = true) ⇒ Object


271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
# File 'lib/xml_security.rb', line 271

def validate_signature(base64_cert, soft = true)

  document = Nokogiri::XML(self.to_s) do |config|
    config.options = XMLSecurity::BaseDocument::NOKOGIRI_OPTIONS
  end

  # create a rexml document
  @working_copy ||= REXML::Document.new(self.to_s).root

  # get signature node
  sig_element = REXML::XPath.first(
      @working_copy,
      "//ds:Signature",
      {"ds"=>DSIG}
  )

  # signature method
  sig_alg_value = REXML::XPath.first(
    sig_element,
    "./ds:SignedInfo/ds:SignatureMethod",
    {"ds"=>DSIG}
  )
  signature_algorithm = algorithm(sig_alg_value)

  # get signature
  base64_signature = REXML::XPath.first(
    sig_element,
    "./ds:SignatureValue",
    {"ds" => DSIG}
  )
  signature = Base64.decode64(OneLogin::RubySaml::Utils.element_text(base64_signature))

  # canonicalization method
  canon_algorithm = canon_algorithm REXML::XPath.first(
    sig_element,
    './ds:SignedInfo/ds:CanonicalizationMethod',
    'ds' => DSIG
  )

  noko_sig_element = document.at_xpath('//ds:Signature', 'ds' => DSIG)
  noko_signed_info_element = noko_sig_element.at_xpath('./ds:SignedInfo', 'ds' => DSIG)

  canon_string = noko_signed_info_element.canonicalize(canon_algorithm)
  noko_sig_element.remove

  # get inclusive namespaces
  inclusive_namespaces = extract_inclusive_namespaces

  # check digests
  ref = REXML::XPath.first(sig_element, "//ds:Reference", {"ds"=>DSIG})
  uri = ref.attributes.get_attribute("URI").value

  hashed_element = document.at_xpath("//*[@ID=$id]", nil, { 'id' => extract_signed_element_id })
  
  canon_algorithm = canon_algorithm REXML::XPath.first(
    ref,
    '//ds:CanonicalizationMethod',
    { "ds" => DSIG }
  )
  canon_hashed_element = hashed_element.canonicalize(canon_algorithm, inclusive_namespaces)

  digest_algorithm = algorithm(REXML::XPath.first(
    ref,
    "//ds:DigestMethod",
    { "ds" => DSIG }
  ))
  hash = digest_algorithm.digest(canon_hashed_element)
  encoded_digest_value = REXML::XPath.first(
    ref,
    "//ds:DigestValue",
    { "ds" => DSIG }
  )
  digest_value = Base64.decode64(OneLogin::RubySaml::Utils.element_text(encoded_digest_value))

  unless digests_match?(hash, digest_value)
    @errors << "Digest mismatch"
    return append_error("Digest mismatch", soft)
  end

  # get certificate object
  cert_text = Base64.decode64(base64_cert)
  cert = OpenSSL::X509::Certificate.new(cert_text)

  # verify signature
  unless cert.public_key.verify(signature_algorithm.new, signature, canon_string)
    return append_error("Key validation error", soft)
  end

  return true
end