Ruby
Latest commit 628afe8 Feb 16, 2017 @md5 md5 committed on GitHub Merge pull request #128 from ilikepi/docs/clarify_sp_metadata_url
docs: clarify SP metadata URL when using Devise

README.md

OmniAuth SAML

Gem Version Build Status Dependency Status Code Climate Coverage Status

A generic SAML strategy for OmniAuth available under the MIT License

https://github.com/omniauth/omniauth-saml

Requirements

  • OmniAuth 1.3+
  • Ruby 1.9.x or Ruby 2.1.x+

Versioning

We tag and release gems according to the Semantic Versioning principle.

Usage

Use the SAML strategy as a middleware in your application:

require 'omniauth'
use OmniAuth::Strategies::SAML,
  :assertion_consumer_service_url     => "consumer_service_url",
  :issuer                             => "issuer",
  :idp_sso_target_url                 => "idp_sso_target_url",
  :idp_sso_target_url_runtime_params  => {:original_request_param => :mapped_idp_param},
  :idp_cert                           => "-----BEGIN CERTIFICATE-----\n...-----END CERTIFICATE-----",
  :idp_cert_fingerprint               => "E7:91:B2:E1:...",
  :idp_cert_fingerprint_validator     => lambda { |fingerprint| fingerprint },
  :name_identifier_format             => "urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress"

or in your Rails application:

in Gemfile:

gem 'omniauth-saml'

and in config/initializers/omniauth.rb:

Rails.application.config.middleware.use OmniAuth::Builder do
  provider :saml,
    :assertion_consumer_service_url     => "consumer_service_url",
    :issuer                             => "rails-application",
    :idp_sso_target_url                 => "idp_sso_target_url",
    :idp_sso_target_url_runtime_params  => {:original_request_param => :mapped_idp_param},
    :idp_cert                           => "-----BEGIN CERTIFICATE-----\n...-----END CERTIFICATE-----",
    :idp_cert_fingerprint               => "E7:91:B2:E1:...",
    :idp_cert_fingerprint_validator     => lambda { |fingerprint| fingerprint },
    :name_identifier_format             => "urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress"
end

For IdP-initiated SSO, users should directly access the IdP SSO target URL. Set the href of your application's login link to the value of idp_sso_target_url. For SP-initiated SSO, link to /auth/saml.

A OneLogin::RubySaml::Response object is added to the env['omniauth.auth'] extra attribute, so we can use it in the controller via env['omniauth.auth'].extra.response_object

Metadata

The service provider metadata used to ease configuration of the SAML SP in the IdP can be retrieved from http://example.com/auth/saml/metadata. Send this URL to the administrator of the IdP.

Note that when integrating with Devise, the URL path will be scoped according to the name of the Devise resource. For example, if the app's user model calls devise_for :users, the metadata URL will be http://example.com/users/auth/saml/metadata.

Options

  • :assertion_consumer_service_url - The URL at which the SAML assertion should be received. If not provided, defaults to the OmniAuth callback URL (typically http://example.com/auth/saml/callback). Optional.

  • :issuer - The name of your application. Some identity providers might need this to establish the identity of the service provider requesting the login. Required.

  • :idp_sso_target_url - The URL to which the authentication request should be sent. This would be on the identity provider. Required.

  • :idp_slo_target_url - The URL to which the single logout request and response should be sent. This would be on the identity provider. Optional.

  • :idp_slo_session_destroy - A proc that accepts up to two parameters (the rack environment, and the session), and performs whatever tasks are necessary to log out the current user from your application. See the example listed under "Single Logout." Defaults to calling #clear on the session. Optional.

  • :slo_default_relay_state - The value to use as default RelayState for single log outs. The value can be a string, or a Proc (or other object responding to call). The request instance will be passed to this callable if it has an arity of 1. If the value is a string, the string will be returned, when the RelayState is called. Optional.

  • :idp_sso_target_url_runtime_params - A dynamic mapping of request params that exist during the request phase of OmniAuth that should to be sent to the IdP after a specific mapping. So for example, a param original_request_param with value original_param_value, could be sent to the IdP on the login request as mapped_idp_param with value original_param_value. Optional.

  • :idp_cert - The identity provider's certificate in PEM format. Takes precedence over the fingerprint option below. This option or :idp_cert_fingerprint or :idp_cert_fingerprint_validator must be present.

  • :idp_cert_fingerprint - The SHA1 fingerprint of the certificate, e.g. "90:CC:16:F0:8D:...". This is provided from the identity provider when setting up the relationship. This option or :idp_cert or :idp_cert_fingerprint_validator MUST be present.

  • :idp_cert_fingerprint_validator - A lambda that MUST accept one parameter (the fingerprint), verify if it is valid and return it if successful. This option or :idp_cert or :idp_cert_fingerprint MUST be present.

  • :name_identifier_format - Used during SP-initiated SSO. Describes the format of the username required by this application. If you need the email address, use "urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress". See http://docs.oasis-open.org/security/saml/v2.0/saml-core-2.0-os.pdf section 8.3 for other options. Note that the identity provider might not support all options. If not specified, the IdP is free to choose the name identifier format used in the response. Optional.

  • :request_attributes - Used to build the metadata file to inform the IdP to send certain attributes along with the SAMLResponse messages. Defaults to requesting name, first_name, last_name and email attributes. See the OneLogin::RubySaml::AttributeService class in the Ruby SAML gem for the available options for each attribute. Set to {} to disable this from metadata.

  • :attribute_service_name - Name for the attribute service. Defaults to Required attributes.

  • :attribute_statements - Used to map Attribute Names in a SAMLResponse to entries in the OmniAuth info hash. For example, if your SAMLResponse contains an Attribute called 'EmailAddress', specify {:email => ['EmailAddress']} to map the Attribute to the corresponding key in the info hash. URI-named Attributes are also supported, e.g. {:email => ['http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress']}. Note: All attributes can also be found in an array under auth_hash[:extra][:raw_info], so this setting should only be used to map attributes that are part of the OmniAuth info hash schema.

  • :uid_attribute - Attribute that uniquely identifies the user. If unset, the name identifier returned by the IdP is used.

  • See the OneLogin::RubySaml::Settings class in the Ruby SAML gem for additional supported options.

Devise Integration

Straightforward integration with Devise, the widely-used authentication solution for Rails.

In config/initializers/devise.rb:

Devise.setup do |config|
  config.omniauth :saml,
    idp_cert_fingerprint: 'fingerprint',
    idp_sso_target_url: 'target_url'
end

Then follow Devise's general OmniAuth tutorial, replacing references to facebook with saml.

Single Logout

Single Logout can be Service Provider initiated or Identity Provider initiated.

For SP initiated logout, the idp_slo_target_url option must be set to the logout url on the IdP, and users directed to user_saml_omniauth_authorize_path + '/spslo' after logging out locally. For IdP initiated logout, logout requests from the IdP should go to /auth/saml/slo (this can be advertised in metadata by setting the single_logout_service_url config option).

When using Devise as an authentication solution, the SP initiated flow can be integrated in the SessionsController#destroy action.

For this to work it is important to preserve the saml_uid value before Devise clears the session and redirect to the /spslo sub-path to initiate the single logout.

Example destroy action in sessions_controller.rb:

class SessionsController < Devise::SessionsController
  # ...

  def destroy
    # Preserve the saml_uid in the session
    saml_uid = session["saml_uid"]
    super do
      session["saml_uid"] = saml_uid
    end
  end

  # ...

  def after_sign_out_path_for(_)
    if session['saml_uid'] && SAML_SETTINGS.idp_slo_target_url
      user_saml_omniauth_authorize_path + "/spslo"
    else
      super
    end
  end
end

By default, omniauth-saml attempts to log the current user out of your application by clearing the session. This may not be enough for some authentication solutions (e.g. Clearance). Instead, you may set the :idp_slo_session_destroy option to a proc that performs the necessary logout tasks.

Example :idp_slo_session_destroy setting for Clearance compatibility:

Rails.application.config.middleware.use OmniAuth::Builder do
  provider :saml, idp_slo_session_destroy: proc { |env, _session| env[:clearance].sign_out }, ...
end

Authors

Authored by Rajiv Aaron Manglani, Raecoo Cao, Todd W Saxton, Ryan Wilcox, Steven Anderson, Nikos Dimitrakopoulos, Rudolf Vriend and Bruno Pedro.