ruby_jwk 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23921b96849d38f01a575f59134abbe026c6848c1cbc4c460c27d92bcf77a809
-  data.tar.gz: b787be04a11e0ffbf0fe9f3c1418747589f60563a7067e8910a741b6b56a6335
+  metadata.gz: 65d30dcf7895ee00236d272c7dbce4572e60cf45a4907ada1cf286e9184516bd
+  data.tar.gz: aaa39468e2fdd1ed1e9299e49d2f4953f149f02100382d6fbfe3bbddc0e5ee2d
 SHA512:
-  metadata.gz: 1dab2c10dcb374bd786b21e244105bd1ef391416838f5736d6fc168a8dcf57a5ac19e3aaabeb37968f230a6bf8fd26b6e49cbb0e9027b79342443bdeaa06d400
-  data.tar.gz: d06b10422d2f8b94def06b55fe6653c818535bed789c83f5cafaf06ed74ca3807bded3fa14d2161f4294aea985cde3c653abb856e9764a3e40dfb18a0fc955b2
+  metadata.gz: 97c756981851f833cd074eae8d2760da354aa77ae5d24f343a8b67e23049265d9f2e3dd83da699194693fe1537c6a8d21cb4da3ca46fe34c6256e09b26f1623d
+  data.tar.gz: ebc2f965cf933e7b17d876e1dc8d7f3d3e94ed0fe1075399bd179122461259c9b87210e76253cdf0340dbb0fe9ac5015a2ae10c778aedd12df11b929a3c8fc53

data/README.md

@@ -1,5 +1,5 @@
 # RubyJwk
-Authenticate JWKs via public JWT enspoint
+Authenticate JWT with JWKs. 
 
 ## Usage
 How to use my plugin.
@@ -20,6 +20,47 @@ Or install it yourself as:
 ```bash
 $ gem install ruby_jwk
 ```
+## Getting started
+
+Authentication system exposes a JWKS endpoint for each tenant, which looks like `https://YOUR_DOMAIN/.well-known/jwks.json`. This endpoint will contain the JWK used to verify all Authentication JWTs for this tenant. This endpoint has to be configured like below in initializer file. 
+
+```ruby
+RubyJwk.jwk_url = 'https://YOUR_DOMAIN/.well-known/jwks.json'
+RubyJwk.skip_issuers = [] # to skip authentication for certain issuers
+```
+
+Suppose each tenant has different endpoint then configure it as below. Here `:tenant_name` gets replaced by `tenant` attribute in JWT payload. 
+
+```ruby
+RubyJwk.jwk_url = 'https://:tenant_name/.well-known/jwks.json'
+```
+
+To set up a controller with tenant authentication, just add this before_action
+
+```ruby
+ class ApplicationController < ActionController::API
+   include RubyJwk::Authenticate
+   before_action :authenticate_tenant!
+end
+```
+To get the JWT payload, use the following helper:
+```ruby
+jwt_payload
+```
+
+To get tenant name from JWT, use the following helper:
+```ruby
+jwt_tenant_name
+```
+
+### Token verification 
+Currently, we support below verifications
+* Signature
+* Token expiry
+* nbf
+
+## Reference
+https://blog.unathichonco.com/verifying-jwts-with-jwks-in-ruby
 
 ## Contributing
 Contribution directions go here.

data/app/controllers/concerns/ruby_jwk/authenticate.rb

@@ -1,7 +1,7 @@
 module RubyJwk
   module Authenticate
     def authenticate_tenant!
-      return if RubyJwk.skip_issuers.to_a.include?(payload[:iss])
+      return if RubyJwk.skip_issuers.to_a.include?(jwt_payload[:iss])
 
       JWT.decode(token, nil, true, { algorithm: 'RS256', jwks: jwk_loader})
     rescue JWT::DecodeError => e
@@ -14,6 +14,10 @@ module RubyJwk
       render status: 401, json: error_response_template("Authentication failed! - #{e.message}")
     end
 
+    def jwt_tenant_name
+      @jwt_payload.dig('tenant')
+    end
+
     private
 
     # invalidate becomes true when kid not found
@@ -30,10 +34,6 @@ module RubyJwk
       end
     end
 
-    def tenant_name
-      @payload.fetch('tenant')
-    end
-
     def error_response_template(msg)
       {
         error: {

data/app/controllers/ruby_jwk/application_controller.rb

@@ -1,7 +1,4 @@
 module RubyJwk
   class ApplicationController < ::ApplicationController
-    def authenticate_tenant!
-      byebug
-    end
   end
 end

data/lib/ruby_jwk/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby_jwk
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - santhanakarthikeyan