nulogy_sso 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45ba41e655cffa293d1750e7d1deb76c115cc001b1c43cb308fcfff3366d3195
-  data.tar.gz: 742eb6f00234afe2923ef22ff29a702c74972103217dca73bcd244af3bc654eb
+  metadata.gz: c4d1f9f535ed99d1575c31fded6cc2712f9bc22f4e19809236ec478a57715792
+  data.tar.gz: 779c7dcb20b58215370b4bae528862c12ce8e528d5f1da9830fafb5f27699c3c
 SHA512:
-  metadata.gz: 0b6b362a2175b9eed9f823c1bd81801c3e6cca6eef7f06208896e5bdd18e4f460f2fd25e3906e85627a550c794cdc73d9950e3cec140d30fbbf9aa2958abbbb4
-  data.tar.gz: 346c484f7aea9dcd0cbc19aa4c528cc2f043a8c2b911f8d5ae85c68898ed97074f75ea762208e7696fc9bb29833b682fb4454ff98933b5d14bb2619f35e4b780
+  metadata.gz: 8b8b7bb65b92718bb6a699e085a00161a1e7895c76b1f339fb0bf4e7962d5708bde3657b24ee5073c8afe1a6adf3dac5eb90eb7f32aedce209c88c7fde3d8af1
+  data.tar.gz: 0676e085475f7915b3f7fff3e6197d27d87856c0aa4853f7fc5c5417dea8e6b7655c88ceccb878a263e4eae64ee59d32d96254be5c1d27467b2e018f1db09670

data/README.md

@@ -1,6 +1,6 @@
 # NulogySSO
 
-![Gem](https://img.shields.io/gem/v/nulogy_sso?label=nulogy_sso)
+[![Gem](https://img.shields.io/gem/v/nulogy_sso?label=nulogy_sso)](https://rubygems.org/gems/nulogy_sso "View this project in Rubygems")
 
 **This repo is still under heavy initial development and is not ready to be used by any other product besides CPI. This status will be changed very shortly.**
 
@@ -32,12 +32,12 @@ get "logout", to: redirect("sso/logout")
 
 The engine now needs to be configured. First create a YAML config file, perhaps named `config/auth_sso.yml`, to configure your app's Auth0 settings. This assumes that the necessary Auth0 applications have been created in the correct Auth0 tenants. The [CPI auth_sso.yml file](https://github.com/nulogy/Common-Platform-Interface/blob/master/config/auth_sso.yml) is a good starting place.
 
-With that available, you can configure the engine with an initializer file. This is where _NulogySSO_ can be customized according to your application's needs. Put the below code into `config/initializers/nulogy_sso.rb`, with the appropriate modifications implemented. For `auth_config`, refer to [nulogy_sso.rb](lib/nulogy_sso.rb) for a list of required keys and [auth_sso.yml](spec/dummy/config/auth_sso.yml) for an example config file.
+With that available, you can configure the engine with an initializer file. This is where _NulogySSO_ can be customized according to your application's needs. Put the below code into `config/initializers/nulogy_sso.rb`, with the appropriate modifications implemented. For `sso_config`, refer to [nulogy_sso.rb](lib/nulogy_sso.rb) for a list of required keys and [sso_config.yml](spec/dummy/config/sso_config.yml) for an example config file.
 
 ```ruby
 # Compiles config/auth_sso.yml into a Ruby object. An error is thrown if required keys are missing.
 # See lib/nulogy_sso.rb for required keys.
-NulogySSO.auth_config = Rails::Application.config_for(:auth_sso)
+NulogySSO.sso_config = Rails::Application.config_for(:sso)
 
 # Return the user matching the provided email, or nil if not found.
 NulogySSO.find_user_by_email = ->(email) { nil } 
@@ -48,7 +48,7 @@ NulogySSO.find_user_by_email = ->(email) { nil }
 NulogySSO.handle_sso_error = ->(controller) { } 
 ```
 
-The app is now ready to authenticate a user with Auth0! With NulogyAuth and Auth0, the user's identity is maintained across requests (and apps!) via a [JWT](https://auth0.com/docs/jwt) stored as a browser cookie. Add this code to the `ApplicationController`:
+The app is now ready to authenticate a user with Auth0! With NulogySSO and Auth0, the user's identity is maintained across requests (and apps!) via a [JWT](https://auth0.com/docs/jwt) stored as a browser cookie. Add this code to the `ApplicationController`:
 
 ```ruby
 class ApplicationController < ActionController::Base
@@ -79,9 +79,9 @@ docker-compose up -d
 
 ### Testing
 
-There are multiple helpers made available via the `NulogyAuth::TestUtilities` module. These are helpful for doing things such as grabbing test JWT values and interacting with a [Mockserver](https://github.com/jamesdbloom/mockserver) mock of the Auth0 API.
+There are multiple helpers made available via the `NulogySSO::TestUtilities` module. These are helpful for doing things such as grabbing test JWT values and interacting with a [Mockserver](https://github.com/jamesdbloom/mockserver) mock of the Auth0 API.
 
-It is a common use case for a Rails app to switch from Devise-powered authentication to Auth0. Here's a pattern that could be applied around a feature flag (e.g. environment variable) to switch between Devise user authentication test helpers and NulogyAuth test helpers: _(TODO: insert link to CPI `ControllerIntegrationSpecMacros`)_
+It is a common use case for a Rails app to switch from Devise-powered authentication to Auth0. Here's a pattern that could be applied around a feature flag (e.g. environment variable) to switch between Devise user authentication test helpers and NulogySSO test helpers: _(TODO: insert link to CPI `ControllerIntegrationSpecMacros`)_
 
 ### Contributing
 

data/app/controllers/nulogy_sso/authentication_controller.rb

@@ -11,17 +11,17 @@ module NulogySSO
 
     def initialize
       # These instance variables have to be set in order for the HTTPProxy mixin to work.
-      @base_uri = auth_config.base_uri
+      @base_uri = sso_config.base_uri
       @headers = { content_type: "application/json" }
     end
 
     def login
-      raw_access_token = cookies[NulogySSO.auth_cookie_key]
+      raw_access_token = cookies[NulogySSO.sso_cookie_key]
 
       authenticator.validate_token(
         raw_access_token,
         on_success: method(:on_authentication_success),
-        on_invalid_token: -> { redirect_to auth_path }
+        on_invalid_token: -> { redirect_to auth0_authorize_path }
       )
     end
 
@@ -41,18 +41,18 @@ module NulogySSO
     end
 
     def logout
-      cookies.delete(NulogySSO.auth_cookie_key, domain: :all)
+      cookies.delete(NulogySSO.sso_cookie_key, domain: :all)
 
       query_params = {
-        returnTo: auth_config.redirect_uri, # Yes, this must be camelCased
-        client_id: auth_config.client_id
+        returnTo: sso_config.redirect_uri, # Yes, this must be camelCased
+        client_id: sso_config.client_id
       }
-      redirect_to "#{auth_config.base_uri}/v2/logout?#{query_params.to_query}"
+      redirect_to "#{sso_config.base_uri}/v2/logout?#{query_params.to_query}"
     end
 
     private
 
-    delegate :auth_config, to: :NulogySSO
+    delegate :sso_config, to: :NulogySSO
 
     def sso_error
       NulogySSO.handle_sso_error.call(self)
@@ -65,20 +65,20 @@ module NulogySSO
     def on_authentication_success(access_token)
       respond_with_cookies(access_token)
 
-      redirect_to params["origin"].presence || auth_config.redirect_uri
+      redirect_to params["origin"].presence || sso_config.redirect_uri
     end
 
     def token_response(code)
       exchange_auth_code_for_tokens(
         code,
-        redirect_uri: auth_config.login_uri,
-        client_id: auth_config.client_id,
-        client_secret: auth_config.client_secret
+        redirect_uri: sso_config.login_uri,
+        client_id: sso_config.client_id,
+        client_secret: sso_config.client_secret
       )
     end
 
     def respond_with_cookies(access_token_value)
-      cookies[NulogySSO.auth_cookie_key] = {
+      cookies[NulogySSO.sso_cookie_key] = {
         value: access_token_value,
         domain: :all,
         expires: 36_000.seconds, # TODO: Fetch this value from the JWT
@@ -87,16 +87,16 @@ module NulogySSO
       }
     end
 
-    def auth_path
+    def auth0_authorize_path
       query_params = {
-        audience: auth_config.audience,
-        client_id: auth_config.client_id,
+        audience: sso_config.audience,
+        client_id: sso_config.client_id,
         response_type: "code",
         scope: "openid email",
-        redirect_uri: "#{auth_config.login_uri}?origin=#{session[:previous_request_url]}"
+        redirect_uri: "#{sso_config.login_uri}?origin=#{session[:previous_request_url]}"
       }
 
-      "#{auth_config.base_uri}/authorize?#{query_params.to_query}"
+      "#{sso_config.base_uri}/authorize?#{query_params.to_query}"
     end
   end
 end

data/app/services/nulogy_sso/authenticator.rb

@@ -5,9 +5,9 @@ require "auth0_rs256_jwt_verifier"
 module NulogySSO
   class Authenticator
     ACCESS_TOKEN_VERIFIER = Auth0RS256JWTVerifier.new(
-      issuer: "#{NulogySSO.auth_config.base_uri}/", # Auth0 requires a backslash on the Issuer
-      audience: NulogySSO.auth_config.audience,
-      jwks_url: "#{NulogySSO.auth_config.base_uri}/.well-known/jwks.json"
+      issuer: "#{NulogySSO.sso_config.base_uri}/", # Auth0 requires a backslash on the Issuer
+      audience: NulogySSO.sso_config.audience,
+      jwks_url: "#{NulogySSO.sso_config.base_uri}/.well-known/jwks.json"
     )
 
     def initialize(verifier: ACCESS_TOKEN_VERIFIER, find_user_by_email: NulogySSO.find_user_by_email)
@@ -15,7 +15,7 @@ module NulogySSO
       @find_user_by_email = find_user_by_email
     end
 
-    # Authorizes the provided JWT, ensuring that a valid user can be associated to the token
+    # Validated the provided JWT, ensuring that an authenticated Auth0 user can be associated to the token and matches an existing app user
     def validate_token(raw_access_token, on_success:, on_invalid_token:)
       access_token = decoded_validated_access_token(raw_access_token)
 

data/lib/nulogy_sso/controller_helper.rb

@@ -16,7 +16,7 @@ module NulogySSO
     end
 
     def authenticate_sso_user
-      raw_token = cookies[NulogySSO.auth_cookie_key]
+      raw_token = cookies[NulogySSO.sso_cookie_key]
       return redirect_to nulogy_sso.login_path if raw_token.blank?
 
       @current_user = Authenticator.new.authenticated_user(raw_token)

data/lib/nulogy_sso/engine.rb

@@ -13,8 +13,8 @@ module NulogySSO
     Bundler.require(*Rails.groups)
 
     config.after_initialize do
-      if NulogySSO.auth_config.blank?
-        raise "Missing auth_config config object. Consider using config_for() to load a YAML config file."
+      if NulogySSO.sso_config.blank?
+        raise "Missing sso_config config object. Consider using config_for() to load a YAML config file."
       end
 
       if NulogySSO.find_user_by_email.blank?

data/lib/nulogy_sso/test_utilities/jwt_test_helper.rb

@@ -20,9 +20,9 @@ module NulogySSO
       def jwt(email, overrides = {})
         claim = {
           NulogySSO::JWT_EMAIL_KEY => email,
-          "iss" => "#{NulogySSO.auth_config.base_uri}/",
+          "iss" => "#{NulogySSO.sso_config.base_uri}/",
           "sub" => "MOCK",
-          "aud" => [NulogySSO.auth_config.audience],
+          "aud" => [NulogySSO.sso_config.audience],
           "exp" => (Time.now + 1.day).to_i
         }.merge(overrides)
 

data/lib/nulogy_sso/version.rb

@@ -1,3 +1,3 @@
 module NulogySSO
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/lib/nulogy_sso.rb

@@ -5,23 +5,23 @@ require "immutable-struct"
 
 module NulogySSO
   # Config variables for the engine
-  mattr_accessor :auth_config, :find_user_by_email, :handle_sso_error
+  mattr_accessor :sso_config, :find_user_by_email, :handle_sso_error
 
   # Public Constants
   JWT_EMAIL_KEY = "https://nulogy.net/email"
 
-  def self.auth_config=(auth_config_hash)
-    raise "auth_config must be a Hash" unless auth_config_hash.is_a? Hash
+  def self.sso_config=(sso_config_hash)
+    raise "sso_config must be a Hash" unless sso_config_hash.is_a? Hash
 
-    missing_keys = REQUIRED_AUTH_CONFIG_KEYS - auth_config_hash.symbolize_keys.keys
+    missing_keys = REQUIRED_SSO_CONFIG_KEYS - sso_config_hash.symbolize_keys.keys
     if missing_keys.present?
-      raise "Missing required auth_config keys ['#{missing_keys.join("', '")}']"
+      raise "Missing required sso_config keys ['#{missing_keys.join("', '")}']"
     end
 
-    @@auth_config = AuthConfig.new(**auth_config_hash.symbolize_keys)
+    @@sso_config = SSOConfig.new(**sso_config_hash.symbolize_keys)
   end
 
-  REQUIRED_AUTH_CONFIG_KEYS = %i[
+  REQUIRED_SSO_CONFIG_KEYS = %i[
     audience
     base_uri
     client_id
@@ -30,11 +30,11 @@ module NulogySSO
     login_uri
     redirect_uri
   ]
-  private_constant :REQUIRED_AUTH_CONFIG_KEYS
+  private_constant :REQUIRED_SSO_CONFIG_KEYS
 
-  AuthConfig = ImmutableStruct.new(*REQUIRED_AUTH_CONFIG_KEYS)
+  SSOConfig = ImmutableStruct.new(*REQUIRED_SSO_CONFIG_KEYS)
 
-  def self.auth_cookie_key
-    "#{auth_config.cookie_prefix}_access_token"
+  def self.sso_cookie_key
+    "#{sso_config.cookie_prefix}_access_token"
   end
 end

data/spec/dummy/config/application.rb

@@ -33,7 +33,7 @@ module Dummy
 
     # Load required NulogySSO config so that the dummy can boot up without error.
     # These functions are mostly used for testing.
-    NulogySSO.auth_config = config_for(:auth_sso)
+    NulogySSO.sso_config = config_for(:sso)
     NulogySSO.find_user_by_email = ->(email) { User.find_by(email: email) }
     NulogySSO.handle_sso_error = ->(controller) { controller.render plain: "An SSO error has occurred :(" }
   end

data/spec/features/nulogy_sso/sso_login_spec.rb

@@ -70,7 +70,7 @@ module NulogySSO
       end
 
       def set_access_token_cookie(token)
-        page.driver.browser.manage.add_cookie(name: NulogySSO.auth_cookie_key, value: token)
+        page.driver.browser.manage.add_cookie(name: NulogySSO.sso_cookie_key, value: token)
       end
     end
 

data/spec/integration/services/nulogy_sso/authenticator_spec.rb

@@ -2,11 +2,11 @@
 
 module NulogySSO
   RSpec.describe Authenticator do
-    let(:auth_config) { NulogySSO.auth_config }
+    let(:sso_config) { NulogySSO.sso_config }
     let(:verifier) do
       MockAuth0Verifier.new(
-        issuer: "#{auth_config.base_uri}/",
-        audience: auth_config.audience,
+        issuer: "#{sso_config.base_uri}/",
+        audience: sso_config.audience,
         jwks: jwt_test_helper.jwks_json
       )
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nulogy_sso
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Nulogy Corporation
@@ -197,7 +197,6 @@ files:
 - spec/dummy/bin/yarn
 - spec/dummy/config.ru
 - spec/dummy/config/application.rb
-- spec/dummy/config/auth_sso.yml
 - spec/dummy/config/boot.rb
 - spec/dummy/config/cable.yml
 - spec/dummy/config/database.yml
@@ -217,6 +216,7 @@ files:
 - spec/dummy/config/puma.rb
 - spec/dummy/config/routes.rb
 - spec/dummy/config/spring.rb
+- spec/dummy/config/sso.yml
 - spec/dummy/config/storage.yml
 - spec/dummy/db/migrate/20190912211120_create_users.rb
 - spec/dummy/db/schema.rb
@@ -372,9 +372,9 @@ test_files:
 - spec/dummy/bin/yarn
 - spec/dummy/bin/rails
 - spec/dummy/config/routes.rb
-- spec/dummy/config/auth_sso.yml
 - spec/dummy/config/locales/en.yml
 - spec/dummy/config/cable.yml
+- spec/dummy/config/sso.yml
 - spec/dummy/config/environments/production.rb
 - spec/dummy/config/environments/development.rb
 - spec/dummy/config/environments/test.rb