samlsso 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6eef1ff2931908247fa908b45369820de85c56e6
+  data.tar.gz: 5fe581ce6f74f9dbcb4ffefab1f39055bb814301
+SHA512:
+  metadata.gz: f8f60a37d9608b41a040cba0b178c8a2696e6f67aee0341944f39622e8bb167acef85299342325d2b0929d2935d43060d244ad26763477d2a124a585bf8cbfbf
+  data.tar.gz: 0ba87a05251f4b3bbfce53fefdcd5b5ebecdbc0074631c634d9b63e151918a8a5a5143e76123cfdbe8b43df0b9674d84f3188c8fbee4e1d5811710662c4c15d4

data/.gitignore

@@ -0,0 +1,50 @@
+*.rbc
+capybara-*.html
+.rspec
+/log
+/tmp
+/db/*.sqlite3
+/db/*.sqlite3-journal
+/public/system
+/coverage/
+/spec/tmp
+/pkg/
+/.yardoc
+/_yardoc/
+/doc/
+/spec/reports/
+**.orig
+rerun.txt
+pickle-email-*.html
+
+
+# TODO Comment out these rules if you are OK with secrets being uploaded to the repo
+config/initializers/secret_token.rb
+config/secrets.yml
+
+# dotenv
+# TODO Comment out this rule if environment variables can be committed
+.env
+
+## Environment normalization:
+/.bundle
+/vendor/bundle
+
+# these should all be checked in to normalize the environment:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# if using bower-rails ignore default bower_components path bower.json files
+/vendor/assets/bower_components
+*.bowerrc
+bower.json
+
+# Ignore pow environment settings
+.powenv
+
+# Ignore Byebug command history file.
+.byebug_history

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at mukherjee.siddhartha@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in samlsso.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Siddhartha Mukherjee
+
+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

@@ -0,0 +1,36 @@
+# Samlsso
+
+SAML SSO for Ruby
+
+(Fork of a old version of https://github.com/onelogin/ruby-saml, but then customized/enhanced to support encrypted SAML and some more)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'samlsso'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install samlsso
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/samlsso. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "samlsso"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/samlsso.rb

@@ -0,0 +1,16 @@
+require 'samlsso/logging'
+require 'samlsso/saml_message'
+require 'samlsso/authrequest'
+require 'samlsso/logoutrequest'
+require 'samlsso/logoutresponse'
+require 'samlsso/attributes'
+require 'samlsso/slo_logoutrequest'
+require 'samlsso/slo_logoutresponse'
+require 'samlsso/response'
+require 'samlsso/settings'
+require 'samlsso/attribute_service'
+require 'samlsso/validation_error'
+require 'samlsso/metadata'
+require 'samlsso/idp_metadata_parser'
+require 'samlsso/utils'
+require 'samlsso/version'

data/lib/samlsso/attribute_service.rb

@@ -0,0 +1,32 @@
+module Samlsso
+    class AttributeService
+      attr_reader :attributes
+      attr_reader :name
+      attr_reader :index
+
+      def initialize
+        @index = "1"
+        @attributes = []
+      end
+
+      def configure(&block)
+        instance_eval &block
+      end
+
+      def configured?
+        @attributes.length > 0 && !@name.nil?
+      end
+
+      def service_name(name)
+        @name = name
+      end
+
+      def service_index(index)
+        @index = index
+      end
+      
+      def add_attribute(options={})
+        attributes << options 
+      end
+    end
+end

data/lib/samlsso/attributes.rb

@@ -0,0 +1,107 @@
+module Samlsso
+    # Wraps all attributes and provides means to query them for single or multiple values.
+    # 
+    # For backwards compatibility Attributes#[] returns *first* value for the attribute.
+    # Turn off compatibility to make it return all values as an array:
+    #    Attributes.single_value_compatibility = false
+    class Attributes
+      include Enumerable
+
+      # By default Attributes#[] is backwards compatible and
+      # returns only the first value for the attribute
+      # Setting this to `false` returns all values for an attribute
+      @@single_value_compatibility = true
+
+      # Get current status of backwards compatibility mode.
+      def self.single_value_compatibility
+        @@single_value_compatibility
+      end
+
+      # Sets the backwards compatibility mode on/off.
+      def self.single_value_compatibility=(value)
+        @@single_value_compatibility = value
+      end
+
+      # Initialize Attributes collection, optionally taking a Hash of attribute names and values.
+      #
+      # The +attrs+ must be a Hash with attribute names as keys and **arrays** as values:
+      #    Attributes.new({
+      #      'name' => ['value1', 'value2'],
+      #      'mail' => ['value1'],
+      #    })
+      def initialize(attrs = {})
+        @attributes = attrs
+      end
+
+
+      # Iterate over all attributes
+      def each
+        attributes.each{|name, values| yield name, values}
+      end
+
+      # Test attribute presence by name
+      def include?(name)
+        attributes.has_key?(canonize_name(name))
+      end
+      
+      # Return first value for an attribute
+      def single(name)
+        attributes[canonize_name(name)].first if include?(name)
+      end
+
+      # Return all values for an attribute
+      def multi(name)
+        attributes[canonize_name(name)]
+      end
+
+      # By default returns first value for an attribute.
+      #
+      # Depending on the single value compatibility status this returns first value
+      #    Attributes.single_value_compatibility = true # Default
+      #    response.attributes['mail']  # => 'user@example.com'
+      #
+      # Or all values:
+      #    Attributes.single_value_compatibility = false
+      #    response.attributes['mail']  # => ['user@example.com','user@example.net']
+      def [](name)
+        self.class.single_value_compatibility ? single(canonize_name(name)) : multi(canonize_name(name))
+      end
+
+      # Return all attributes as an array
+      def all
+        attributes
+      end
+
+      # Set values for an attribute, overwriting all existing values
+      def set(name, values)
+        attributes[canonize_name(name)] = values
+      end
+      alias_method :[]=, :set
+
+      # Add new attribute or new value(s) to an existing attribute
+      def add(name, values = [])
+        attributes[canonize_name(name)] ||= []
+        attributes[canonize_name(name)] += Array(values)
+      end
+
+      # Make comparable to another Attributes collection based on attributes
+      def ==(other)
+        if other.is_a?(Attributes)
+          all == other.all
+        else
+          super
+        end
+      end
+
+      protected
+
+      # stringifies all names so both 'email' and :email return the same result
+      def canonize_name(name)
+        name.to_s
+      end
+
+      def attributes
+        @attributes
+      end
+    end
+end

data/lib/samlsso/authrequest.rb

@@ -0,0 +1,124 @@
+require "uuid"
+
+require "samlsso/logging"
+
+module Samlsso
+  include REXML
+    class Authrequest < SamlMessage
+
+      attr_reader :uuid # Can be obtained if neccessary
+
+      def initialize
+        @uuid = "_" + UUID.new.generate
+      end
+
+      def create(settings, params = {})
+        params = create_params(settings, params)
+        params_prefix = (settings.idp_sso_target_url =~ /\?/) ? '&' : '?'
+        saml_request = CGI.escape(params.delete("SAMLRequest"))
+        request_params = "#{params_prefix}SAMLRequest=#{saml_request}"
+        params.each_pair do |key, value|
+          request_params << "&#{key.to_s}=#{CGI.escape(value.to_s)}"
+        end
+        @login_url = settings.idp_sso_target_url + request_params
+      end
+
+      def create_params(settings, params={})
+        params = {} if params.nil?
+
+        request_doc = create_authentication_xml_doc(settings)
+        request_doc.context[:attribute_quote] = :quote if settings.double_quote_xml_attribute_values
+
+        request = ""
+        request_doc.write(request)
+
+        Logging.debug "Created AuthnRequest: #{request}"
+
+        request = deflate(request) if settings.compress_request
+        base64_request = encode(request)
+        request_params = {"SAMLRequest" => base64_request}
+
+        if settings.security[:authn_requests_signed] && !settings.security[:embed_sign] && settings.private_key
+          params['SigAlg']    = XMLSecurity::Document::SHA1
+          url_string          = "SAMLRequest=#{CGI.escape(base64_request)}"
+          url_string         += "&RelayState=#{CGI.escape(params['RelayState'])}" if params['RelayState']
+          url_string         += "&SigAlg=#{CGI.escape(params['SigAlg'])}"
+          private_key         = settings.get_sp_key()
+          signature           = private_key.sign(XMLSecurity::BaseDocument.new.algorithm(settings.security[:signature_method]).new, url_string)
+          params['Signature'] = encode(signature)
+        end
+
+        params.each_pair do |key, value|
+          request_params[key] = value.to_s
+        end
+
+        request_params
+      end
+
+      def create_authentication_xml_doc(settings)
+        time = Time.now.utc.strftime("%Y-%m-%dT%H:%M:%SZ")
+
+        request_doc = XMLSecurity::Document.new
+        request_doc.uuid = uuid
+
+        root = request_doc.add_element "samlp:AuthnRequest", { "xmlns:samlp" => "urn:oasis:names:tc:SAML:2.0:protocol", "xmlns:saml" => "urn:oasis:names:tc:SAML:2.0:assertion" }
+        root.attributes['ID'] = uuid
+        root.attributes['IssueInstant'] = time
+        root.attributes['Version'] = "2.0"
+        root.attributes['Destination'] = settings.idp_sso_target_url unless settings.idp_sso_target_url.nil?
+        root.attributes['IsPassive'] = settings.passive unless settings.passive.nil?
+        root.attributes['ProtocolBinding'] = settings.protocol_binding unless settings.protocol_binding.nil?
+        root.attributes["AttributeConsumingServiceIndex"] = settings.attributes_index unless settings.attributes_index.nil?
+        root.attributes['ForceAuthn'] = settings.force_authn unless settings.force_authn.nil?
+
+        # Conditionally defined elements based on settings
+        if settings.assertion_consumer_service_url != nil
+          root.attributes["AssertionConsumerServiceURL"] = settings.assertion_consumer_service_url
+        end
+        if settings.issuer != nil
+          issuer = root.add_element "saml:Issuer"
+          issuer.text = settings.issuer
+        end
+        if settings.name_identifier_format != nil
+          root.add_element "samlp:NameIDPolicy", {
+              # Might want to make AllowCreate a setting?
+              "AllowCreate" => "true",
+              "Format" => settings.name_identifier_format
+          }
+        end
+
+        if settings.authn_context || settings.authn_context_decl_ref
+
+          if settings.authn_context_comparison != nil
+            comparison = settings.authn_context_comparison
+          else
+            comparison = 'exact'
+          end
+
+          requested_context = root.add_element "samlp:RequestedAuthnContext", {
+            "Comparison" => comparison,
+          }
+
+          if settings.authn_context != nil
+            class_ref = requested_context.add_element "saml:AuthnContextClassRef"
+            class_ref.text = settings.authn_context
+          end
+          # add saml:AuthnContextDeclRef element
+          if settings.authn_context_decl_ref != nil
+            class_ref = requested_context.add_element "saml:AuthnContextDeclRef"
+            class_ref.text = settings.authn_context_decl_ref
+          end
+        end
+
+        # embebed sign
+        if settings.security[:authn_requests_signed] && settings.private_key && settings.certificate && settings.security[:embed_sign] 
+          private_key = settings.get_sp_key()
+          cert = settings.get_sp_cert()
+          request_doc.sign_document(private_key, cert, settings.security[:signature_method], settings.security[:digest_method])
+        end
+
+        request_doc
+      end
+
+    end
+end