osso 0.0.5.pre.delta → 0.0.5.pre.epsilon

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9762b3c9f7bae7bbb066f2ad4a80cc6ee8b360a730781983712d2b61465e2de2
-  data.tar.gz: 498ad481465fece9cbe1a2045972cfb0e7719ce91e00446085dd88a5eca3b045
+  metadata.gz: 82bd613a1b8d5eb4f9c549d9d855c629698a120d2ee99bf3a52f6911fa4d080a
+  data.tar.gz: a67aec622f76bcc42cc16065d11a795c09893caa1115759b5739fa384108f6f2
 SHA512:
-  metadata.gz: b59eb8d8e3008fe05db242994a1e58b7698b72d4ae657c54fe5a8a3e6d8d6db54b69bbefcef4480c7b901ef9a3b7bb3abed575fbf2f76fe9ba5e52901cd29886
-  data.tar.gz: b54fa57263e4b675ec4a8feb2d51e8266621663ca4036b61b114aeae4134a6d089ed99ebbc82c75caf44968b082e1e37be4cc74cbd3c6ffa72cd1f75938f4f91
+  metadata.gz: c2a1ba5df34d2e175ed7a3ab7e61dcb573b5eb9a636753f7159860f817e6b61515b9350b63a1ac1ffece994f27a7f17d61d2de05e5f6a0468168cfb7a268f879
+  data.tar.gz: 475eba77f824e32701ff9eae95bef4663f2e0de8d43c9d542846f6ecaec55edb1242251cb4ed50b9cb1db627252293cf406a633cc8c0c63fb7f419e10dc95e3c

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    osso (0.0.5.pre.gamma)
+    osso (0.0.5.pre.epsilon)
       activesupport (>= 6.0.3.2)
       graphql
       jwt

data/lib/osso.rb

@@ -1,10 +1,12 @@
 # frozen_string_literal: true
 
 module Osso
+  require_relative 'osso/error/error'
   require_relative 'osso/helpers/helpers'
   require_relative 'osso/lib/app_config'
   require_relative 'osso/lib/oauth2_token'
   require_relative 'osso/lib/route_map'
+  require_relative 'osso/lib/saml_handler'
   require_relative 'osso/models/models'
   require_relative 'osso/routes/routes'
   require_relative 'osso/graphql/schema'

data/lib/osso/error/error.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Osso
+  module Error
+  end
+end
+
+require_relative 'missing_saml_attribute_error'
+require_relative 'oauth_error'
+require_relative 'saml_config_error'

data/lib/osso/error/missing_saml_attribute_error.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Osso
+  module Error
+    class MissingSamlAttributeError < StandardError; end
+
+    class MissingSamlEmailAttributeError < MissingSamlAttributeError
+      def message
+        'SAML response does not include the attribute `email`. ' \
+          "Review the setup guide and check the attributes you're sending from your Identity Provider."
+      end
+    end
+
+    class MissingSamlIdAttributeError < MissingSamlAttributeError
+      def message
+        'SAML response does not include the attribute `id` or `idp_id`.' \
+          "Review the setup guide and check the attributes you're sending from your Identity Provider."
+      end
+    end
+  end
+end

data/lib/osso/error/oauth_error.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Osso
+  module Error
+    class OAuthError < StandardError; end
+
+    class NoAccountForOAuthClientError < OAuthError
+      def message
+        'No customer account exists for the requested domain and OAuth client pair.' \
+          "Review our OAuth documentation, and check you're using the correct OAuth client identifier"
+      end
+    end
+
+    class InvalidOAuthClientIdentifier < MissingSamlAttributeError
+      def message
+        'No OAuth client exists for the requested OAuth client identifier.' \
+          "Review our OAuth documentation, and check you're using the correct OAuth client identifier"
+      end
+    end
+
+    class InvalidRedirectUri < MissingSamlAttributeError
+      def message
+        'Invalid Redirect URI for the requested OAuth client identifier.' \
+          "Review our OAuth documentation, check you're using the correct OAuth client identifier " \
+          'and confirm your Redirect URI allow list.'
+      end
+    end
+  end
+end

data/lib/osso/error/saml_config_error.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Osso
+  module Error
+    class SamlConfigError < StandardError; end
+
+    class InvalidACSURLError < SamlConfigError
+      def message
+        'The ACS URL specfied in your Identity Provider configuration is malformed.'
+      end
+    end
+  end
+end

data/lib/osso/lib/saml_handler.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module Osso
+  class SamlHandler
+    attr_accessor :session, :provider, :attributes
+
+    def self.perform(**attrs)
+      new(attrs).perform
+    end
+
+    def initialize(auth_hash:, provider_id:, session:)
+      find_provider(provider_id)
+      @attributes = auth_hash&.extra&.response_object&.attributes
+      @session = session
+    end
+
+    def perform
+      validate_attributes
+      provider.active!
+      redirect_uri
+    end
+
+    private
+
+    def find_provider(id)
+      @provider ||= Models::IdentityProvider.find(id)
+    rescue ActiveRecord::RecordNotFound
+      raise Osso::Error::InvalidACSURLError
+    end
+
+    def validate_attributes
+      raise Osso::Error::MissingSamlIdAttributeError unless id_attribute
+      raise Osso::Error::MissingSamlEmailAttributeError unless email_attribute
+    end
+
+    def id_attribute
+      @id_attribute ||= attributes[:id] || attributes[:idp_id]
+    end
+
+    def email_attribute
+      attributes[:email]
+    end
+
+    def user
+      @user ||= Models::User.where(
+        email: email_attribute,
+        idp_id: id_attribute,
+      ).first_or_create! do |new_user|
+        new_user.enterprise_account_id = provider.enterprise_account_id
+        new_user.identity_provider_id = provider.id
+      end
+    end
+
+    def authorization_code
+      @authorization_code ||= user.authorization_codes.create!(
+        oauth_client: provider.oauth_client,
+        redirect_uri: redirect_uri_base,
+      )
+    end
+
+    def redirect_uri
+      redirect_uri_base + redirect_uri_querystring
+    end
+
+    def redirect_uri_base
+      return provider.oauth_client.primary_redirect_uri.uri if valid_idp_initiated_flow
+
+      session[:osso_oauth_redirect_uri]
+    end
+
+    def redirect_uri_querystring
+      "?code=#{CGI.escape(authorization_code.token)}&state=#{provider_state}"
+    end
+
+    def provider_state
+      return 'IDP_INITIATED' if valid_idp_initiated_flow
+
+      session.delete(:osso_oauth_state)
+    end
+
+    def valid_idp_initiated_flow
+      !session[:osso_oauth_redirect_uri] && !session[:osso_oauth_state]
+    end
+  end
+end

data/lib/osso/routes/auth.rb

@@ -27,9 +27,16 @@ module Osso
       end
     end
 
-    namespace '/auth' do # rubocop:disable Metrics/BlockLength
+    OmniAuth.config.on_failure = proc do |env|
+      OmniAuth::FailureEndpoint.new(env).redirect_to_failure
+    end
+
+    error do
+      erb :error
+    end
+
+    namespace '/auth' do
       get '/failure' do
-        @error = params[:message]
         erb :error
       end
       # Enterprise users are sent here after authenticating against
@@ -37,47 +44,17 @@ module Osso
       # and then create an authorization code for that user. The user
       # is redirected back to your application with this code
       # as a URL query param, which you then exchange for an access token.
-      post '/saml/:id/callback' do
-        provider = Models::IdentityProvider.find(params[:id])
-        @oauth_client = provider.oauth_client
-
-        # TODO: PORC for validating attributes
-        attributes = env['omniauth.auth']&.
-          extra&.
-          response_object&.
-          attributes
-
-        user = Models::User.where(
-          email: attributes[:email],
-          idp_id: attributes[:id] || attributes[:idp_id],
-        ).first_or_create! do |new_user|
-          new_user.enterprise_account_id = provider.enterprise_account_id
-          new_user.identity_provider_id = provider.id
-        end
-
-        authorization_code = user.authorization_codes.create!(
-          oauth_client: @oauth_client,
-          redirect_uri: redirect_uri,
+      post '/saml/:provider_id/callback' do
+        redirect_uri = SamlHandler.perform(
+          auth_hash: env['omniauth.auth'],
+          provider_id: params[:provider_id],
+          session: session,
         )
-        provider.active!
-
-        redirect(redirect_uri + "?code=#{CGI.escape(authorization_code.token)}&state=#{provider_state}")
-      end
-
-      def redirect_uri
-        return @oauth_client.primary_redirect_uri.uri if valid_idp_initiated_flow
-
-        session[:osso_oauth_redirect_uri]
-      end
 
-      def provider_state
-        return @provider_state = 'IDP_INITIATED' if valid_idp_initiated_flow
-
-        session.delete(:osso_oauth_state)
-      end
-
-      def valid_idp_initiated_flow
-        !session[:osso_oauth_redirect_uri] && !session[:osso_oauth_state]
+        redirect(redirect_uri)
+      rescue Osso::Error::InvalidACSURLError => e
+        @error = e
+        erb :error
       end
     end
   end

data/lib/osso/routes/oauth.rb

@@ -16,28 +16,18 @@ module Osso
       # Once they complete IdP login, they will be returned to the
       # redirect_uri with an authorization code parameter.
       get '/authorize' do
-        Rack::OAuth2::Server::Authorize.new do |req, _res|
-          client = Models::OauthClient.find_by!(identifier: req.client_id)
-          session[:osso_oauth_redirect_uri] = req.verify_redirect_uri!(client.redirect_uri_values)
-          session[:osso_oauth_state] = params[:state]
-        end.call(env)
+        client = find_client(params[:client_id])
+        enterprise = find_account(domain: params[:domain], client_id: client.id)
 
-        enterprise = Models::EnterpriseAccount.
-          includes(:identity_providers).
-          find_by!(domain: params[:domain])
+        validate_oauth_request(env)
 
         redirect "/auth/saml/#{enterprise.provider.id}" if enterprise.single_provider?
 
         @providers = enterprise.identity_providers
         erb :multiple_providers
 
-      rescue Rack::OAuth2::Server::Authorize::BadRequest => e
-        @error = e
-        erb :error
-      rescue ActiveRecord::RecordNotFound => e
+      rescue Osso::Error::OAuthError => e
         @error = e
-        @error = 'No OAuth Client exists for the provided client_id' if e.model == 'Osso::Models::OauthClient'
-        @error = "No Customer exists with the domain #{params[:domain]}" if e.model == 'Osso::Models::EnterpriseAccount'
         erb :error
       end
 
@@ -66,5 +56,31 @@ module Osso
           user
       end
     end
+
+    private
+
+    def find_account(domain:, client_id:)
+      Models::EnterpriseAccount.
+        includes(:identity_providers).
+        find_by!(domain: domain, oauth_client_id: client_id)
+    rescue ActiveRecord::RecordNotFound
+      raise Osso::Error::NoAccountForOAuthClientError
+    end
+
+    def find_client(identifier)
+      @client ||= Models::OauthClient.find_by!(identifier: identifier)
+    rescue ActiveRecord::RecordNotFound
+      raise Osso::Error::InvalidOAuthClientIdentifier
+    end
+
+    def validate_oauth_request(env)
+      Rack::OAuth2::Server::Authorize.new do |req, _res|
+        client = find_client(req[:client_id])
+        session[:osso_oauth_redirect_uri] = req.verify_redirect_uri!(client.redirect_uri_values)
+        session[:osso_oauth_state] = params[:state]
+      end.call(env)
+    rescue Rack::OAuth2::Server::Authorize::BadRequest
+      raise Osso::Error::InvalidRedirectUri
+    end
   end
 end

data/lib/osso/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Osso
-  VERSION = '0.0.5-delta'
+  VERSION = '0.0.5-epsilon'
 end

data/spec/lib/saml_handler_spec.rb

@@ -0,0 +1 @@
+

data/spec/routes/auth_spec.rb

@@ -43,7 +43,6 @@ describe Osso::Auth do
               nil,
               {
                 'omniauth.auth' => OmniAuth.config.mock_auth[:saml],
-                'identity_provider' => okta_provider,
               },
             )
           end.to change { Osso::Models::User.count }.by(1)
@@ -58,7 +57,6 @@ describe Osso::Auth do
               nil,
               {
                 'omniauth.auth' => OmniAuth.config.mock_auth[:saml],
-                'identity_provider' => okta_provider,
               },
             )
           end.to change { Osso::Models::AuthorizationCode.count }.by(1)
@@ -73,7 +71,6 @@ describe Osso::Auth do
               nil,
               {
                 'omniauth.auth' => OmniAuth.config.mock_auth[:saml],
-                'identity_provider' => okta_provider,
               },
             )
             expect(last_response).to be_redirect
@@ -99,7 +96,6 @@ describe Osso::Auth do
               nil,
               {
                 'omniauth.auth' => OmniAuth.config.mock_auth[:saml],
-                'identity_provider' => okta_provider,
               },
             )
           end.to_not(change { Osso::Models::User.count })
@@ -110,7 +106,6 @@ describe Osso::Auth do
             nil,
             {
               'omniauth.auth' => OmniAuth.config.mock_auth[:saml],
-              'identity_provider' => okta_provider,
             },
           )
           expect(okta_provider.reload.status).to eq('ACTIVE')
@@ -132,7 +127,6 @@ describe Osso::Auth do
               nil,
               {
                 'omniauth.auth' => OmniAuth.config.mock_auth[:saml],
-                'identity_provider' => azure_provider,
               },
             )
           end.to change { Osso::Models::User.count }.by(1)
@@ -146,7 +140,6 @@ describe Osso::Auth do
             nil,
             {
               'omniauth.auth' => OmniAuth.config.mock_auth[:saml],
-              'identity_provider' => azure_provider,
             },
           )
 
@@ -170,7 +163,6 @@ describe Osso::Auth do
               nil,
               {
                 'omniauth.auth' => OmniAuth.config.mock_auth[:saml],
-                'identity_provider' => azure_provider,
               },
             )
           end.to_not(change { Osso::Models::User.count })
@@ -178,4 +170,39 @@ describe Osso::Auth do
       end
     end
   end
+
+  context 'with an invalid SAML response' do
+    describe 'post /auth/saml/:uuid/callback' do
+      let!(:enterprise) { create(:enterprise_with_azure) }
+      let!(:azure_provider) { enterprise.provider }
+
+      it 'raises an error when email is missing' do
+        mock_saml_omniauth(email: nil, id: SecureRandom.uuid)
+
+        expect do
+          post(
+            "/auth/saml/#{azure_provider.id}/callback",
+            nil,
+            {
+              'omniauth.auth' => OmniAuth.config.mock_auth[:saml],
+            },
+          )
+        end.to raise_error(Osso::Error::MissingSamlEmailAttributeError)
+      end
+
+      it 'raises an error when id is missing' do
+        mock_saml_omniauth(email: Faker::Internet.email, id: nil)
+
+        expect do
+          post(
+            "/auth/saml/#{azure_provider.id}/callback",
+            nil,
+            {
+              'omniauth.auth' => OmniAuth.config.mock_auth[:saml],
+            },
+          )
+        end.to raise_error(Osso::Error::MissingSamlIdAttributeError)
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: osso
 version: !ruby/object:Gem::Version
-  version: 0.0.5.pre.delta
+  version: 0.0.5.pre.epsilon
 platform: ruby
 authors:
 - Sam Bauch
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-18 00:00:00.000000000 Z
+date: 2020-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -273,6 +273,10 @@ files:
 - lib/osso/db/migrate/20200826201852_create_app_config.rb
 - lib/osso/db/migrate/20200913154919_add_one_login_to_identity_provider_service_enum.rb
 - lib/osso/db/migrate/20200916125543_add_google_to_identity_provider_service_enum.rb
+- lib/osso/error/error.rb
+- lib/osso/error/missing_saml_attribute_error.rb
+- lib/osso/error/oauth_error.rb
+- lib/osso/error/saml_config_error.rb
 - lib/osso/graphql/.DS_Store
 - lib/osso/graphql/mutation.rb
 - lib/osso/graphql/mutations.rb
@@ -313,6 +317,7 @@ files:
 - lib/osso/lib/app_config.rb
 - lib/osso/lib/oauth2_token.rb
 - lib/osso/lib/route_map.rb
+- lib/osso/lib/saml_handler.rb
 - lib/osso/models/access_token.rb
 - lib/osso/models/app_config.rb
 - lib/osso/models/authorization_code.rb
@@ -347,6 +352,7 @@ files:
 - spec/graphql/query/identity_provider_spec.rb
 - spec/graphql/query/oauth_clients_spec.rb
 - spec/helpers/auth_spec.rb
+- spec/lib/saml_handler_spec.rb
 - spec/models/identity_provider_spec.rb
 - spec/routes/admin_spec.rb
 - spec/routes/app_spec.rb