go_sso 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94692c360a28d7beff1f95900b6b798d2bee7a554e988f003623ed8675969751
-  data.tar.gz: 63990eb7c21d4f8d4316d143abad2596a9533b43576021e00b441595664b076b
+  metadata.gz: 5699d1f30c56dc29ad69891e7e0e5f78328ebbc77be73bf064a98d910f2f5f2a
+  data.tar.gz: 3a0a7805c36f40ff2ac6b15fb46da68af237f3fa1b3ef51eb546c1833db6c1ff
 SHA512:
-  metadata.gz: eb726512139fcae3835d644f31304ae509509eefab7a19bcdba264eba04601ea76bc3d4b674480ceead8757e0a9d9bbdd0bc21b5654011c2fa4fcea6c4c78da7
-  data.tar.gz: f77a159bf650f9a855a059cbb416954b22a39d96a76477834fbd88b1f8584e1a454ce7126662751c8796d592e40bd1f71d9ce9a56294696b8dcfe9c7947057cb
+  metadata.gz: 8ee99a7199532820c1cf592af33afb156d9c783daa091fb1c88b6a7fb20fbd5cf75a5dc4b1aa0019bd1e2f277abc61842df13f276dd5fe472ab3b57c505676df
+  data.tar.gz: 69f5d732f77dcb087796457b5776d9052a8d5b1823153633269b4d9950ba4ccb40717650d278b0d51974474feb11e5331447a118f27156c646a966a5f96ed520

data/README.md

@@ -0,0 +1,47 @@
+# GoSSO
+
+This is a plugin to protect applications from access by unauthorized users. 
+You need to have your own OAuth server as SSO(Single Sign On) server 
+then install this plugin to each application need to be protected.  
+
+Set the SSO server secrets through environment variables:
+```
+GO_SSO_CLIENT_ID=
+GO_SSO_CLIENT_SECRET=
+GO_SSO_CLIENT_SITE=
+```
+
+Create a initializer file for other configurations:
+
+```
+GoSso.setup do |config|
+  config.client_id # GO_SSO_CLIENT_ID
+  config.client_secret # GO_SSO_CLIENT_SECRET
+  config.site # GO_SSO_CLIENT_SITE
+  config.user_json_url # default: 'api/me'
+  config.user_cache_ttl # default 1.minute
+  config.main_app_module_name # default is your host app module name
+  config.host # set to your app host
+  config.fake_user_json # set this options for development or test environment only
+end
+```
+
+You must implement `api/me` to response user information in JSON format which provides `applications` attribute at least.
+`applications` is an array of strings. 
+
+Add `before :authenticate_sso_user_permission` to application controllers.
+Pages with this hook will be protected. 
+If `current_sso_user` is not present, redirect users to SSO to login.
+Users can access the protected page only if after login and their applications attribute contains `main_app_module_name`
+
+You can access current user in views or controllers via `current_sso_user`.
+
+In a development environment, it is probably without SSO server support. When `fake_user_json` option is set, users will always login successfully and its user JSON will be `fake_user_json`:
+```
+GoSso.setup do |config|
+  # other configurations...
+  if Rails.env.development?
+    config.fake_user_json = { uid: 1, email: 'yfxie@me.com' }
+  end
+end
+```

data/app/controllers/go_sso/application_controller.rb

@@ -8,12 +8,17 @@ module GoSso
 
     def auth
       session[:go_sso_referrer] = params[:redirect_url] || request.referrer || request.base_url
-      redirect_to GoSso.authorize_url
+      if GoSso.test_mode?
+        redirect_to go_sso_callback_url
+      else
+        redirect_to GoSso.authorize_url
+      end
     end
 
     def callback
-      token = GoSso.get_token(params[:code])
+      token = GoSso.test_mode? ? GoSso.generate_fake_token : GoSso.get_token(params[:code])
       set_sso_token(token.token, expires_at: token.expires_at)
+      GoSso.after_login.call(self)
       redirect_to session.delete(:go_sso_referrer) || request.base_url
     rescue OAuth2::Error => error
       render json: {
@@ -36,9 +41,5 @@ module GoSso
         session[:go_sso_token] = session[:go_sso_token_expires_at] = nil
       end
     end
-
-    def sso_token_expired?
-      session[:go_sso_token_expires_at] < Time.now.to_i
-    end
   end
 end

data/config/routes.rb

@@ -1,7 +1,7 @@
 Rails.application.routes.draw do
-  namespace :go_sso do
-    get :auth, to: 'application#auth'
-    get :callback, to: 'application#callback'
-    delete :logout, to: 'application#logout'
+  scope GoSso.routes_prefix do
+    get :auth, to: 'go_sso/application#auth', as: :go_sso_auth
+    get :callback, to: 'go_sso/application#callback', as: :go_sso_callback
+    delete :logout, to: 'go_sso/application#logout', as: :go_sso_logout
   end
 end

data/lib/go_sso.rb

@@ -15,6 +15,9 @@ module GoSso
   mattr_accessor :user_cache_ttl, default: 1.minute
   mattr_accessor :main_app_module_name
   mattr_accessor :host
+  mattr_accessor :fake_user_json
+  mattr_accessor :after_login, default: ->(ctx){}
+  mattr_accessor :routes_prefix, default: "/go_sso"
 
   def self.setup
     yield self
@@ -47,6 +50,25 @@ module GoSso
     host || Current.host
   end
 
+  def self.get_user_json(token = nil)
+    return fake_user_json.as_json if test_mode?
+    o_token = OAuth2::AccessToken.new(client, token)
+    json_str = Rails.cache.fetch([:go_sso_user, token], expires_in: user_cache_ttl) do
+      o_token.get(GoSso.user_json_url).body
+    end
+    JSON.parse(json_str)
+  rescue Faraday::ConnectionFailed
+    raise GoSso::FailedToOpenConnection
+  end
+
+  def self.test_mode?
+    fake_user_json.present?
+  end
+
+  def self.generate_fake_token
+    OAuth2::AccessToken.new(client, SecureRandom.urlsafe_base64, expires_in: 2.hours)
+  end
+
   class FailedToOpenConnection < Exception; end
 end
 

data/lib/go_sso/controllers/helpers.rb

@@ -17,7 +17,8 @@ module GoSso
         @current_sso_user ||= begin
           return nil unless session[:go_sso_token]
           return nil if sso_token_expired?
-          GoSso::User.from_token(session[:go_sso_token])
+          user_json = GoSso.get_user_json(session[:go_sso_token])
+          GoSso::User.new(user_json)
         end
       rescue OAuth2::Error
         nil
@@ -29,9 +30,13 @@ module GoSso
         end
 
         unless current_sso_user.can_access?(GoSso.main_app_module_name)
-          render json: { message: 'access denied' }, status: 401
+          return render json: { message: 'access denied' }, status: 401
         end
       end
+
+      def sso_token_expired?
+        session[:go_sso_token_expires_at] < Time.now.to_i
+      end
     end
   end
 end

data/lib/go_sso/user.rb

@@ -19,15 +19,4 @@ class GoSso::User
       super
     end
   end
-
-  def self.from_token(token)
-    o_token = OAuth2::AccessToken.new(GoSso.client, token)
-    json_str = Rails.cache.fetch([:go_sso_user, token], expires_in: GoSso.user_cache_ttl) do
-      o_token.get(GoSso.user_json_url).body
-    end
-    attrs = JSON.parse(json_str)
-    new(attrs)
-  rescue Faraday::ConnectionFailed
-    raise GoSso::FailedToOpenConnection
-  end
 end

data/lib/go_sso/version.rb

@@ -1,3 +1,3 @@
 module GoSso
-  VERSION = '0.1.0'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: go_sso
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Yi Feng
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-10-24 00:00:00.000000000 Z
+date: 2021-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2
@@ -116,6 +116,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - MIT-LICENSE
+- README.md
 - Rakefile
 - app/assets/config/go_sso_manifest.js
 - app/assets/stylesheets/go_sso/application.css
@@ -123,7 +124,6 @@ files:
 - app/helpers/go_sso/application_helper.rb
 - app/jobs/go_sso/application_job.rb
 - app/mailers/go_sso/application_mailer.rb
-- app/models/go_sso/application_record.rb
 - app/views/layouts/go_sso/application.html.erb
 - config/routes.rb
 - lib/go_sso.rb
@@ -137,7 +137,7 @@ homepage: https://github.com/yfxie/go_sso
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -152,8 +152,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.0.8
+signing_key:
 specification_version: 4
 summary: Summary of GoSso.
 test_files: []

data/app/models/go_sso/application_record.rb

@@ -1,5 +0,0 @@
-module GoSso
-  class ApplicationRecord < ActiveRecord::Base
-    self.abstract_class = true
-  end
-end