deep_health_check 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 071ba6ac81c18713dfcf0bcffbe653acc6615df5a20b5ddca96c00c052ee9cff
-  data.tar.gz: c149da4b8f07c18c5ce3969cfccb8e8287003993624ab154023ddf20ed29b4e9
+  metadata.gz: 16addd0eb6fc25b77649cb745c0be9db5fa9eff31f522794a51292506ea9eb72
+  data.tar.gz: 5de87ad71baefa6117a048e5cb7e62fb912d5c3f9ebc52dceffc3bc14ccaf8f2
 SHA512:
-  metadata.gz: e66155ed93d57af3980075f92126ce498031b4bf7c919812748b08947f4d452a5fe1547232344e6d1d01f61f9e376d9fac26a433f663864b10a8052e802ead72
-  data.tar.gz: 6e43262184f5e3172bcb5f85ef4f119b035b032623bd3f557a95924fcbfdec432fc8708f0dfdcea99b937194da90412a4ba31da8666b93c52a82ccc29b2597bc
+  metadata.gz: e1de2527b764d477aa90b8ef2b842e202ab7416dd089b351deb7af40fdeb5c1c54ed7a3d5b02c5ba9e8a232a6eb2f8e6ea7129f1e5c0d7e93add908fa09bf8bf
+  data.tar.gz: 9285c90ce3ed9410c6b6cc73a4350c855df846b8009ffb6fbcf12fbfe2e8e6b03ca6be5fb7102372ecf8a8ef9f283db931627de68ff697bf491ba808f482c694

data/README.md

@@ -25,7 +25,14 @@ if other middleware fails when database is down for example ActiveRecord::QueryC
  config.middleware.insert_after "Rails::Rack::Logger", DeepHealthCheck::MiddlewareHealthCheck
 ~~~
 
+Or for protecting all endpoits with hatauth 
 
+~~~sh
+# config/application.rb
+config.middleware.use DeepHealthCheck::BasicAuthHealthCheck  do |username, password|
+  username == "$USER" && password == "$PASS"
+end
+~~~
 
 
 # Protect Health Check endpoints using htauth credentials.
@@ -45,6 +52,6 @@ Health check middleware expose the following endpoints
        HTTP_DEPENDENCY_00=http://127.0.0.0:8080/health
        ```
 
-Some of these endpoints provide information about the database and system status. By Default these endpoints are not protected and are accessible publicly. To reduce the security risk introduced by exposing these endpoints, We can protect them using htauth credentials. The following page provide all the necessary steps needed to achieve this task.
+Some of these endpoints provide information about the database and system status. By Default these endpoints are not protected and are accessible publicly. To reduce the security risk introduced by exposing these endpoints, We can protect them using htauth credentials. The following page provide all the necessary steps needed to achieve this task using nginx.
 
 [Nginx Configurations](NGINX.md)

data/deep_health_check.gemspec

@@ -30,5 +30,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rack-test', '~> 1.1', '>= 1.1.0'
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.9', '>= 3.9.0'
-  spec.add_development_dependency 'rubocop', '1.23.0'
+  spec.add_development_dependency 'rubocop', '1.24.0'
 end

data/lib/deep_health_check/basic_auth_health_check.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module DeepHealthCheck
+  class BasicAuthHealthCheck < Rack::Auth::Basic
+    def call(env)
+      auth = ::Rack::Auth::Basic::Request.new(env)
+      if env['PATH_INFO'].match(/^\/((db|tcp|http)_)?(dependencies_)?health$/)
+        return unauthorized unless auth.provided?
+        return bad_request unless auth.basic?
+
+        if valid?(auth)
+          env['REMOTE_USER'] = auth.username
+          health_check = HealthCheckBuilder.build env['PATH_INFO']
+          return (health_check&.call || @app.call(env))
+        end
+
+        unauthorized
+      else
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/deep_health_check/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DeepHealthCheck
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 end

data/lib/deep_health_check.rb

@@ -8,6 +8,7 @@ require 'deep_health_check/tcp_dependency_health_check'
 require 'deep_health_check/http_dependency_health_check'
 require 'deep_health_check/health_check_builder'
 require 'deep_health_check/middleware_health_check'
+require 'deep_health_check/basic_auth_health_check'
 
 module DeepHealthCheck
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deep_health_check
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Al-waleed shihadeh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-19 00:00:00.000000000 Z
+date: 2021-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -126,14 +126,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.23.0
+        version: 1.24.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.23.0
+        version: 1.24.0
 description: Provides a health check API endpoint for rack apps
 email:
 - shihadeh.dev@gmail.com
@@ -159,6 +159,7 @@ files:
 - bin/travis
 - deep_health_check.gemspec
 - lib/deep_health_check.rb
+- lib/deep_health_check/basic_auth_health_check.rb
 - lib/deep_health_check/db_health_check.rb
 - lib/deep_health_check/dependency_health_check.rb
 - lib/deep_health_check/health_check.rb