go_sso 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94692c360a28d7beff1f95900b6b798d2bee7a554e988f003623ed8675969751
-  data.tar.gz: 63990eb7c21d4f8d4316d143abad2596a9533b43576021e00b441595664b076b
+  metadata.gz: 141663866cb0c76ce7d600625d230153c747493dd4814ad5dd3a79e7d8cd8846
+  data.tar.gz: 686176927a42cd377a4dc38bc9eca2125c812b70366b695603187365a58bc2ce
 SHA512:
-  metadata.gz: eb726512139fcae3835d644f31304ae509509eefab7a19bcdba264eba04601ea76bc3d4b674480ceead8757e0a9d9bbdd0bc21b5654011c2fa4fcea6c4c78da7
-  data.tar.gz: f77a159bf650f9a855a059cbb416954b22a39d96a76477834fbd88b1f8584e1a454ce7126662751c8796d592e40bd1f71d9ce9a56294696b8dcfe9c7947057cb
+  metadata.gz: 92ebdb0a8e6ad0a81de62f66c15cd6891b1dc836a88203a1c3c251de604e3499a249f160b74937c0d3d6782144b15bfe5dd066d76cf15e93f49d982a2343a800
+  data.tar.gz: c42f320ed2432412fe15ac7415f7b8d52f82a5f4a417d78ff76c6f6d3c5d2191b3d5e8edc88eb3fcb7f2147635cd14fef9abc8e2b15aa526a3ecbea126125bea

data/README.md

@@ -0,0 +1,36 @@
+# 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
+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`.

data/app/controllers/go_sso/application_controller.rb

@@ -36,9 +36,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/lib/go_sso/controllers/helpers.rb

@@ -32,6 +32,10 @@ module GoSso
           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/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: go_sso
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Yi Feng
@@ -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