jay_doubleu_tee 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b97cdc198e67deb3e7bf32f6ea85eefb1b0a8a03f566c38205cd64ab017e412
-  data.tar.gz: 2d5177eec6bbd60fcdea34209c47a916efdf425668576436016f1754cc23ef22
+  metadata.gz: 99f790e08b792c0ba695a3a4f58a763d9dde8ce4115e945f28d3cf43da6c4118
+  data.tar.gz: e2041a8d8edf5a0b2caf14dbfeb6e64839e3bc4146a80b08e02df6f071fa724c
 SHA512:
-  metadata.gz: 5fe6669fbe10bb8a0d8bf6ee8f398cb34eac32811b0e9111102687491bbd5d3252ffc8fbde1c6bc48a6217c769e1bfdb9bc092c360d8d3403e6b4d927ce50c20
-  data.tar.gz: ca25e6aa0658a1266a2c6ba1b50580e2fda619be0ae34750417fbb2f5ea2b214eb11a748a000965b97554fcd6a5d4365b03025aead23f7af7908f68ee794c73f
+  metadata.gz: 173ceb6452a1084064adb766cf711b0ed4f4891da056e67bb1cd1cfec2584591f270a13a0e1caa74b3338fbe3941480e601f7c81a721a3162587a7165bb7f63f
+  data.tar.gz: 44b3582ca38846273810922bbfd7175f65da84bbfd71a66057af29bf382211c89fea23982e24caf9f62eaf6ec2755b0f1eb860aa672dcfdea745fe2e50ac7f49

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jay_doubleu_tee (0.2.1)
+    jay_doubleu_tee (0.3.0)
       dry-configurable
       dry-effects
       dry-monads

data/README.md

@@ -49,12 +49,7 @@ class App
   include JayDoubleuTee::Auth
 
   def call(env)
-    status, body =
-      if auth.success?
-        [200, [{ message: "Hello, World!", auth: auth.value! }]]
-      else
-        [401, [{ error: auth.failure }.to_json]]
-      end
+    status, body = [200, [{ message: "Hello, World!", auth: auth.value! }]]
 
     [status, headers, body]
   end
@@ -66,7 +61,12 @@ class App
   end
 end
 
-use JayDoubleuTee::Authentication
+JayDoubleuTee.configure do |config|
+  config.algorithm = 'RS256'
+  config.secret = ENV['JAY_DOUBLEU_TEE_PUBLIC_KEY']
+end
+
+use JayDoubleuTee::Authorization
 
 run App.new
 ```
@@ -98,7 +98,7 @@ curl --location --request GET 'http://localhost:9292' \
 # config.ru
 
 require "jay_doubleu_tee"
-use JayDoubleuTee::Authentication
+use JayDoubleuTee::Authorization
 ```
 
 ### Rails
@@ -107,7 +107,7 @@ use JayDoubleuTee::Authentication
 # config.ru
 
 require "jay_doubleu_tee"
-use JayDoubleuTee::Authentication
+use JayDoubleuTee::Authorization
 ```
 
 #### Supported algorithms
@@ -135,6 +135,28 @@ end
 
 Again, for information how to generate private and public keys, [jwt documentation](https://github.com/jwt/ruby-jwt#algorithms-and-usage) or check out the [spec files](https://github.com/hanamimastery/jay_doubleu_tee/tree/master/spec/jay_doubleu_tee/decoder_spec.rb)
 
+**Authorizing by default**
+
+JayDoubleuTee uses secure by default principle, adding authorization to all endpoints using the middleware. If you don't want to authorize all responses by default, you can override the corresponding setting.
+
+```ruby
+JayDoubleuTee.configure do |config|
+  config.authorize_by_default = false
+end
+```
+
+Then in your action you need to handle authorization failure on your own.
+
+```ruby
+  if auth.success?
+    [200, [{ message: "Hello, World!", auth: auth.value! }]]
+  else
+    [401, [{ error: auth.failure }.to_json]]
+  end
+```
+
+This may be useful if you have only one component in your application using the JWT flow, while the rest use different authorization mechanism.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/jay_doubleu_tee/authorization.rb

@@ -7,17 +7,33 @@ module JayDoubleuTee
   class Authorization
     include Dry::Effects::Handler.Reader(:auth)
 
-    attr_reader :decoder
+    attr_reader :decoder, :config
 
     def initialize(app)
       @app = app
       @decoder = Decoder.new
+      @config = JayDoubleuTee.config
     end
 
     def call(env)
-      with_auth(decoder.call(env["HTTP_AUTHORIZATION"])) do
+      auth = decoder.call(env["HTTP_AUTHORIZATION"])
+
+      return authorization_error(auth) if unauthorized?(auth)
+
+      with_auth(auth) do
         @app.call(env)
       end
     end
+
+    private
+
+    def authorization_error(auth)
+      headers = { 'Content-Type' => 'application/json' }
+      [ 401, headers, [{ error: auth.failure }.to_json]]
+    end
+
+    def unauthorized?(auth)
+      config.authorize_by_default && auth.failure?
+    end
   end
 end

data/lib/jay_doubleu_tee/version.rb

@@ -1,3 +1,3 @@
 module JayDoubleuTee
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

data/lib/jay_doubleu_tee.rb

@@ -20,4 +20,6 @@ module JayDoubleuTee
   end
 
   setting :secret, default: ENV['JAY_DOUBLEU_TEE_PUBLIC_KEY']
+
+  setting :authorize_by_default, default: true
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jay_doubleu_tee
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Sebastian Wilgosz
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-12-30 00:00:00.000000000 Z
+date: 2021-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jwt