rx-healthcheck 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a5089cc2aca4dab181a11a5aa9a3135862d7de57976ded482366a9e147ac7a8
-  data.tar.gz: 4ec642b3e93f6b0f983cb7dff58b4bed8ede3e64dd7655bd1cac7f76583c7dfe
+  metadata.gz: 83bc5957f3ce3f426b416b53e7d2e24782da340da998a030cd5f15c04d6b9dde
+  data.tar.gz: 5d6d75b3be95189399d743c234d0303d17183f43482a51ef20a1bed15d59e482
 SHA512:
-  metadata.gz: 439bc089d1ce63f1c63f687cdf0b8b473bbcb2f6bbf3c04a847905d176cdb667e6f6c3b6e754121af685b87fc2b00f318ca3e4c6fc2de17fd80cd4cd88693ff2
-  data.tar.gz: 37c97bcd6967d3d336e669d78b6474978771c0d7dbc79daca8276dd66484c2485398f1cc6bd888c5f46f63e4855c33c9b4bb70a7b7e042937b588259e7b61a0f
+  metadata.gz: 182ab4e67e807f373b4148f492e4cfc62d1f7af7176d187edc86a2282fd65813436b1fc65d71313c2bcebc6a559c2d28fe9140ffe4fb277922e2a4a610805dd1
+  data.tar.gz: e1e7bbeb1240b5994433b8e27775cb5ca5a9dab74fd3159b69ef1c5d93a76468a8c74068f65776b052b0ca1b219d1b4caf1bd50b1982f844f7b726101b0ed9e0

data/README.md

@@ -59,14 +59,30 @@ deep_secondary: []
 
 Each collection must contain 0 or more `Rx::Check` objects. Those checks will be performed when the health check is queried. Deep checks will always also run the readiness checks.
 
+### Deep end-point authorization
+
+It is considered as a good practice to protect the deep checks with a GUID to mitigate DDOS attacks. Hence you have 2 options to enable this. One is to use the `default_authorization` by passing the token to the authorization inside options hash, which you can use in a request with the authorization_token in the header of it. The other option would be to pass a lambda with an env argument (this gives you access to hash of request data) and have your own `custom_authorization`:
+
+```ruby
+options: {
+  #default
+  authorization: <token>
+
+  #custom
+  authorization: -> (env) {
+    #your code goes here
+  }
+ }
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/zachpendleton/rx.
 
 Some tips for developing the gem locally:
 
-* Tests can be run by calling `rake`
-* You can point your Rails app to a local gem by adding a `path` option to your Gemfile, a la `gem "rx", path: "path/to/rx" (though you _will_ need to restart Rails whenever you change the gem).
+- Tests can be run by calling `rake`
+- You can point your Rails app to a local gem by adding a `path` option to your Gemfile, a la `gem "rx", path: "path/to/rx" (though you _will_ need to restart Rails whenever you change the gem).
 
 ## License
 

data/lib/rx/middleware.rb

@@ -3,7 +3,8 @@ require "json"
 module Rx
   class Middleware
     DEFAULT_OPTIONS = {
-      cache: true
+      cache: true,
+      authorization: nil
     }.freeze
 
     def initialize(app,
@@ -34,12 +35,16 @@ module Rx
       when "/readiness"
         readiness_response(check_to_component(readiness_checks))
       when "/deep"
-        @cache.cache("deep") do
-          readiness = check_to_component(readiness_checks)
-          critical  = check_to_component(deep_critical_checks)
-          secondary = check_to_component(deep_secondary_checks)
-
-          deep_response(readiness, critical, secondary)
+        if !Rx::Util::HealthCheckAuthorization.new(env, @options[:authorization]).ok?
+          deep_response_authorization_failed
+        else
+          @cache.cache("deep") do
+            readiness = check_to_component(readiness_checks)
+            critical  = check_to_component(deep_critical_checks)
+            secondary = check_to_component(deep_secondary_checks)
+
+            deep_response(readiness, critical, secondary)
+          end
         end
       end
     end
@@ -79,6 +84,14 @@ module Rx
       ]
     end
 
+    def deep_response_authorization_failed
+      [
+        403,
+        {"content-type" => "application/json"},
+        [JSON.dump({ message: "authorization failed" })]
+      ]
+    end
+
     def deep_response(readiness, critical, secondary)
       status = (readiness.map { |x| x[:status] == 200 } + critical.map { |x| x[:status] == 200 }).all? ? 200 : 503
 

data/lib/rx/util/health_check_authorization.rb

@@ -0,0 +1,25 @@
+module Rx
+  module Util
+    class HealthCheckAuthorization
+      HTTP_HEADER = "HTTP_AUTHORIZATION"
+
+      def initialize(env, authorization)
+        @authorization = authorization
+        @env = env
+      end
+
+      def ok?
+        case @authorization
+          when NilClass
+            true
+          when Proc
+            @authorization.call(@env)
+          when String
+            @authorization == @env[HTTP_HEADER]
+          else
+            raise StandardError.new("Authorization is not configured properly")
+        end
+      end
+    end
+  end
+end

data/lib/rx/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Rx
-  VERSION = "0.1.6"
+  VERSION = "0.1.7"
 end

data/lib/rx.rb

@@ -12,6 +12,7 @@ require_relative "rx/check/result"
 require_relative "rx/concurrent/future"
 require_relative "rx/concurrent/thread_pool"
 require_relative "rx/util/heap"
+require_relative "rx/util/health_check_authorization"
 
 module Rx
   class Error < StandardError; end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: rx-healthcheck
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Zach Pendleton
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-09-29 00:00:00.000000000 Z
+date: 2022-01-11 00:00:00.000000000 Z
 dependencies: []
-description: 
+description:
 email:
 - zachpendleton@gmail.com
 executables: []
@@ -36,6 +36,7 @@ files:
 - lib/rx/concurrent/future.rb
 - lib/rx/concurrent/thread_pool.rb
 - lib/rx/middleware.rb
+- lib/rx/util/health_check_authorization.rb
 - lib/rx/util/heap.rb
 - lib/rx/version.rb
 - rx.gemspec
@@ -45,7 +46,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/zachpendleton/rx
   source_code_uri: https://github.com/zachpendleton/rx
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -60,8 +61,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: Standard health checks for Rails and Rack applications
 test_files: []