SAML Tools¶ ↑

Tools to simplify the creation, validation and sending of SAML objects.

These tools are available as a gem:

gem ‘saml_tools’

Version of OpenSSL::X509::Certificate that adds methods to simplify the retrieval of data used in SAML responses.

Decodes base64 and unzips content.

Zips content and base64 encodes it.

Used to build SAML content from erb templates.

output = SamlTool::ErbBuilder.build(
  template: '<foo><%= settings %></foo>',
  settings: 'bar'
)
output == '<foo>bar</foo>'

Wraps SAML documents and exposes data via methods

reader = SamlTool::Reader.new(
           output,
           {foo: '//foo/text()'}
         )
reader.foo == 'bar'

Used to construct redirection uris

redirect = Redirect.uri(
  to: 'http://example.com',
  data: {
    foo: 'bar'
  }
)
redirect == "http://example.com?foo=bar"

A version of SamlTool::Reader tailored for handling SAML responses. It includes a valid? method that validates the SAML structure and checks the signature is correct.

Version of OpenSSL::PKey::RSA that adds methods to simplify the retrieval of data used in SAML responses.

A wrapper for Nokogiri::XML, that applies defaults that are appropriate for SAML

Packages up settings so that they can be more easily passed to other objects.

Compares documents with SAML schemas to test if they have a valid structure.

I’ve blogged here about some of highs and lows of building these tools.

There is a demo app that I have been working with as I’ve developed these tools:

https://github.com/warwickshire/saml_tools_demo

This work has been greatly influenced by:

• github.com/onelogin/ruby-saml

• onelogin.zendesk.com/hc/en-us/articles/201175674-SAML-toolkit-for-Ruby-on-Rails

• samltool-j.appspot.com/saml_demo.jsp

• www.oasis-open.org/committees/documents.php?wg_abbrev=security

• en.wikipedia.org/wiki/SAML_2.0

• github.com/lawrencepit/ruby-saml-idp

• users.dcc.uchile.cl/~pcamacho/tutorial/web/xmlsec/xmlsec.html

• github.com/digidentity/libsaml