omniauth-saml 1.1.0 → 2.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 032f34c12924a5666a189462f819b871c2e321891cbe23b45e56c47acdbfc53c
+  data.tar.gz: 17bb6e9741181862fcb34f3ca0a47084b9805aba71b3dd5dadfb951c7cd20d27
+SHA512:
+  metadata.gz: eb87a7392dc23407ab0064b67efd4ffefd9ec3fbbca18b32e96bf973281dffb9477bffc3765d8b4c3e278df7aedca255a95aa03deb44053b33c3cfff5af9435e
+  data.tar.gz: 22daef0cc26447f27023c5dc2e6f816e1f79c57c0538b86ffae0f8a2ea9d08492bc351aa31838ca7b4a272ae577aea3f914a87dba0656e1ac2e098f49f034041

data/CHANGELOG.md

@@ -1,35 +1,182 @@
-# OmniAuth SAML Version History
+<a name="v2.1.0"></a>
+### v2.1.0 (2022-03-01)
 
-A generic SAML strategy for OmniAuth.
 
-https://github.com/PracticallyGreen/omniauth-saml
+#### Refactor
 
+* Rename usage of deprecated SAML options  ([74ed8df](/../../commit/74ed8df))
 
-## 1.1.0 (2013-11-07)
+#### Chores
+
+* bump ruby-saml to 1.12  ([15c156a](/../../commit/15c156a))
+
+<a name="v2.0.0"></a>
+### v2.0.0 (2021-01-13)
+
+
+#### Chores
+
+* Allow OmniAuth 2.0.0	 ([f7ec7ee](/../../commit/f7ec7ee))
+
+
+<a name="v1.10.3"></a>
+### v1.10.3 (2020-10-06)
+
+
+#### Bug Fixes
+
+* add options to logout_request initialization	 ([c271a37](/../../commit/c271a37))
+
+
+<a name="v1.10.2"></a>
+### v1.10.2 (2018-05-23)
+
+
+#### Features
+
+* **saml**
+  * inherits allows response options from ruby-saml instead of whitelist	 ([a0eedd6](/../../commit/a0eedd6))
+
+
+<a name="v1.10.1"></a>
+### v1.10.1 (2018-06-07)
+
+
+#### Features
+
+* **saml-response**
+  * whitelist more response options	 ([575198d](/../../commit/575198d))
+
+
+<a name="v1.10.0"></a>
+### v1.10.0 (2018-02-19)
+
+
+#### Bug Fixes
+
+* ambiguous path match in other phase	 ([1b465b9](/../../commit/1b465b9))
+* Update ruby-saml gem to 1.7 or later to fix CVE-2017-11430 ([6bc28ad](/../../commit/6bc28ad))
+
+
+<a name="v1.9.0"></a>
+### v1.9.0 (2018-01-29)
+
+
+#### Bug Fixes
+
+* Update omniauth gem to 1.3.2 or later 1.3.x	 ([b6bb425](/../../commit/b6bb425))
+
+
+<a name="v1.8.1"></a>
+### v1.8.1 (2017-06-22)
+
+
+#### Bug Fixes
+
+* default assertion_consumer_service_url not set during callback	 ([4a2a5ef](/../../commit/4a2a5ef))
+
+
+<a name="v1.8.0"></a>
+### v1.8.0 (2017-06-07)
+
+
+#### Features
+
+* include SessionIndex in logout requests	 ([fb6ad86](/../../commit/fb6ad86))
+* Support for configurable IdP SLO session destruction	 ([586bf89](/../../commit/586bf89))
+* Add `uid_attribute` option to control the attribute used for the user id.	 ([eacc536](/../../commit/eacc536))
+
+
+<a name="v1.7.0"></a>
+### v1.7.0 (2016-10-19)
+
+#### Features
+
+* Support for Single Logout	 ([cd3fc43](/../../commit/cd3fc43))
+* Add issuer information to the metadata endpoint, to allow IdPs to properly configure themselves.	 ([7bbbb67](/../../commit/7bbbb67))
+* Added the response object to the extra['response_object'], so we can use the raw response object if we want to.	 ([76ed3d6](/../../commit/76ed3d6))
+
+#### Chores
+
+* Update `ruby-saml` to 1.4.0 to address security fixes. ([638212](/../../commit/638212))
+
+<a name="v1.6.0"></a>
+### v1.6.0 (2016-06-27)
+* Ensure that subclasses of `OmniAuth::Stategies::SAML` are registered with OmniAuth as strategies (https://github.com/omniauth/omniauth-saml/pull/95)
+* Update ruby-saml to 1.3 to address [CVE-2016-5697](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2016-5697) (Signature wrapping attacks)
+
+<a name="v1.5.0"></a>
+### v1.5.0 (2016-02-25)
+
+* Initialize OneLogin::RubySaml::Response instance with settings
+* Adding "settings" to Response Class at initialization to handle signing verification
+* Support custom attributes
+* change URL from PracticallyGreen to omniauth
+* Add specs for ACS fallback URL behavior
+* Call validation earlier to get real error instead of 'response missing name_id'
+* Avoid mutation of the options hash during requests and callbacks
+
+<a name="v1.4.2"></a>
+### v1.4.2 (2016-02-09)
+
+* update ruby-saml to 1.1
+
+<a name="v1.4.1"></a>
+### v1.4.1 (2015-08-09)
+
+* Configurable attribute_consuming_service
+
+<a name="v1.4.0"></a>
+### v1.4.0 (2015-07-23)
+
+* update ruby-saml to 1.0.0
+
+<a name="v1.3.1"></a>
+### v1.3.1 (2015-02-26)
+
+* Added missing fingerprint key check
+* Expose fingerprint on the auth_hash
+
+<a name="v1.3.0"></a>
+### v1.3.0 (2015-01-23)
+
+* add `idp_cert_fingerprint_validator` option
+
+<a name="v1.2.0"></a>
+### v1.2.0 (2014-03-19)
+
+* provide SP metadata at `/auth/saml/metadata`
+
+<a name="v1.1.0"></a>
+### v1.1.0 (2013-11-07)
 
 * no longer set a default `name_identifier_format`
 * pass strategy options to the underlying ruby-saml library
 * fallback to omniauth callback url if `assertion_consumer_service_url` is not set
 * add `idp_sso_target_url_runtime_params` option
 
-## 1.0.0 (2012-11-12)
+<a name="v1.0.0"></a>
+### v1.0.0 (2012-11-12)
 
 * remove SAML code and port to ruby-saml gem
 * fix incompatibility with OmniAuth 1.1
 
-## 0.9.2 (2012-03-30)
+<a name="v0.9.2"></a>
+### v0.9.2 (2012-03-30)
 
 * validate the SAML response
 * 100% test coverage
 * now requires ruby 1.9.2+
 
-## 0.9.1 (2012-02-23)
+<a name="v0.9.1"></a>
+### v0.9.1 (2012-02-23)
 
 * return first and last name in the info hash
 * no longer use LDAP OIDs for name and email selection
 * return SAML attributes as the omniauth raw_info hash
 
-## 0.9.0 (2012-02-14)
+<a name="v0.9.0"></a>
+### v0.9.0 (2012-02-14)
 
 * initial release
 * extracts commits from omniauth 0-3-stable branch

data/LICENSE.md

@@ -0,0 +1,25 @@
+# License
+
+Copyright © 2016 Omniauth-SAML maintainers
+
+Copyright © 2011-2014 [Practically Green, Inc.](http://www.practicallygreen.com/).
+
+All rights reserved. Released under the MIT license.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -1,13 +1,26 @@
 # OmniAuth SAML
 
-A generic SAML strategy for OmniAuth.
+[![Gem Version](http://img.shields.io/gem/v/omniauth-saml.svg)][gem]
+[![Ruby](https://github.com/omniauth/omniauth-saml/actions/workflows/ruby.yml/badge.svg)](https://github.com/omniauth/omniauth-saml/actions/workflows/ruby.yml)
+[![Maintainability](https://api.codeclimate.com/v1/badges/749e17b553ea944522c1/maintainability)][codeclimate]
+[![Coverage Status](http://img.shields.io/coveralls/omniauth/omniauth-saml.svg)][coveralls]
 
-https://github.com/PracticallyGreen/omniauth-saml
+[gem]: https://rubygems.org/gems/omniauth-saml
+[codeclimate]: https://codeclimate.com/github/omniauth/omniauth-saml/maintainability
+[coveralls]: https://coveralls.io/r/omniauth/omniauth-saml
+
+A generic SAML strategy for OmniAuth available under the [MIT License](LICENSE.md)
+
+https://github.com/omniauth/omniauth-saml
 
 ## Requirements
 
-* [OmniAuth](http://www.omniauth.org/) 1.1+
-* Ruby 1.9.2
+* [OmniAuth](http://www.omniauth.org/) 1.3+
+* Ruby 2.4.x+
+
+## Versioning
+
+We tag and release gems according to the [Semantic Versioning](http://semver.org/) principle. In addition to the guidelines of Semantic Versioning, we follow a further guideline that otherwise backwards-compatible dependency upgrades for security reasons should generally be cause for a MINOR version upgrade as opposed to a PATCH version upgrade. Backwards-incompatible dependency upgrades for security reasons should still result in a MAJOR version upgrade for this library.
 
 ## Usage
 
@@ -17,11 +30,16 @@ 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},
+  :sp_entity_id                       => "sp_entity_id",
+  :idp_sso_service_url                => "idp_sso_service_url",
+  :idp_sso_service_url_runtime_params => {:original_request_param => :mapped_idp_param},
   :idp_cert                           => "-----BEGIN CERTIFICATE-----\n...-----END CERTIFICATE-----",
+  :idp_cert_multi                     => {
+                                           :signing => ["-----BEGIN CERTIFICATE-----\n...-----END CERTIFICATE-----", "-----BEGIN CERTIFICATE-----\n...-----END CERTIFICATE-----", ...],
+                                           :encryption => []
+                                         }
   :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"
 ```
 
@@ -39,16 +57,29 @@ 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},
+    :sp_entity_id                       => "rails-application",
+    :idp_sso_service_url                => "idp_sso_service_url",
+    :idp_sso_service_url_runtime_params => {:original_request_param => :mapped_idp_param},
     :idp_cert                           => "-----BEGIN CERTIFICATE-----\n...-----END CERTIFICATE-----",
+    :idp_cert_multi                     => {
+                                             :signing => ["-----BEGIN CERTIFICATE-----\n...-----END CERTIFICATE-----", "-----BEGIN CERTIFICATE-----\n...-----END CERTIFICATE-----", ...],
+                                             :encryption => []
+                                           }
     :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`.
+For IdP-initiated SSO, users should directly access the IdP SSO service URL. Set the `href` of your application's login link to the value of `idp_sso_service_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`
+
+## SP 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](#devise-integration), 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
 
@@ -56,25 +87,45 @@ For IdP-initiated SSO, users should directly access the IdP SSO target URL. Set
   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
+* `:sp_entity_id` - 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.
+* `:idp_sso_service_url` - The URL to which the authentication request should be sent.
   This would be on the identity provider. **Required**.
 
-* `:idp_sso_target_url_runtime_params` - A dynamic mapping of request params that exist
+* `:idp_slo_service_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_service_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` must
+  over the fingerprint option below. This option or `:idp_cert_multi` or `:idp_cert_fingerprint` or `:idp_cert_fingerprint_validator` must
   be present.
+  
+* `:idp_cert_multi` - Multiple identity provider certificates in PEM format. Takes precedence
+over the fingerprint option below. This option `:idp_cert` 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` must be present.
+  the relationship. This option or `:idp_cert` or `:idp_cert_multi` 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_multi` 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
@@ -84,33 +135,117 @@ For IdP-initiated SSO, users should directly access the IdP SSO target URL. Set
   If not specified, the IdP is free to choose the name identifier format used
   in the response. Optional.
 
-* See the `Onelogin::Saml::Settings` class in the [Ruby SAML gem](https://github.com/onelogin/ruby-saml) for additional supported options.
+* `: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](https://github.com/onelogin/ruby-saml) for the available options for each attribute. Set to `{}` to disable this from metadata.
 
-## Authors
+* `: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](https://github.com/intridea/omniauth/wiki/Auth-Hash-Schema#schema-10-and-later).
+  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](https://github.com/onelogin/ruby-saml) for additional supported options.
+
+## IdP Metadata
+
+You can use the `OneLogin::RubySaml::IdpMetadataParser` to configure some options:
 
-Authored by Raecoo Cao, Todd W Saxton, Ryan Wilcox, Rajiv Aaron Manglani, Steven Anderson, and Nikos Dimitrakopoulos.
+```ruby
+require 'omniauth'
+idp_metadata_parser = OneLogin::RubySaml::IdpMetadataParser.new
+idp_metadata = idp_metadata_parser.parse_remote_to_hash("http://idp.example.com/saml/metadata")
+
+# or, if you have the metadata in a String:
+# idp_metadata = idp_metadata_parser.parse_to_hash(idp_metadata_xml)
+
+use OmniAuth::Strategies::SAML,
+  idp_metadata.merge(
+    :assertion_consumer_service_url => "consumer_service_url",
+    :sp_entity_id                   => "sp_entity_id"
+  )
+```
 
-Maintained by [Rajiv Aaron Manglani](http://www.rajivmanglani.com/).
+See the [Ruby SAML gem's README](https://github.com/onelogin/ruby-saml#metadata-based-configuration) for more details.
 
-## License
+## Devise Integration
 
-Copyright (c) 2011-2013 [Practically Green, Inc.](http://www.practicallygreen.com/).
-All rights reserved. Released under the MIT license.
+Straightforward integration with [Devise](https://github.com/plataformatec/devise), the widely-used authentication solution for Rails.
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+In `config/initializers/devise.rb`:
 
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
+```ruby
+Devise.setup do |config|
+  config.omniauth :saml,
+    idp_cert_fingerprint: 'fingerprint',
+    idp_sso_service_url: 'idp_sso_service_url'
+end
+```
+
+Then follow Devise's general [OmniAuth tutorial](https://github.com/plataformatec/devise/wiki/OmniAuth:-Overview), 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_service_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` and `saml_session_index` 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`:
+
+```ruby
+class SessionsController < Devise::SessionsController
+  # ...
+
+  def destroy
+    # Preserve the saml_uid and saml_session_index in the session
+    saml_uid = session['saml_uid']
+    saml_session_index = session['saml_session_index']
+    super do
+      session['saml_uid'] = saml_uid
+      session['saml_session_index'] = saml_session_index
+    end
+  end
+
+  # ...
+
+  def after_sign_out_path_for(_)
+    if session['saml_uid'] && session['saml_session_index'] && SAML_SETTINGS.idp_slo_service_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](https://github.com/thoughtbot/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:
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :saml, idp_slo_session_destroy: proc { |env, _session| env[:clearance].sign_out }, ...
+end
+```
+
+## Authors
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+Authored by [Rajiv Aaron Manglani](http://www.rajivmanglani.com/), Raecoo Cao, Todd W Saxton, Ryan Wilcox, Steven Anderson, Nikos Dimitrakopoulos, Rudolf Vriend and [Bruno Pedro](http://brunopedro.com/).