liveness 0.2.2 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8c4374a066d22f71ed43d6cbef9d3e8fa84d91ee74f4dcd99420dc1f0f05232
-  data.tar.gz: '0482fa040d357f8b4486576ababe08591dbc589a3e353bee9f0b4c9e332baf70'
+  metadata.gz: 630199531d58103ad49748b74a839676e701ac9e85efb7f2880f9242b66ae30b
+  data.tar.gz: 11efa4ea8d069d8fcd1d132eeaad736b2f3755ee390ea147b40843b68795a202
 SHA512:
-  metadata.gz: f2f68bd1ee8ea102b3c8517f839e0d750ee6d9dc32487d8c9578ff31635eb5f1ae1b7eea39e1f0825438e9ff572824ee41d7dd49e8956ad938e7aa37d16dbdc9
-  data.tar.gz: f0083b3f15da4d97f12561f29af8628bf0b02ea53cd083d98783e5d5b29fb4bffdd4de90672ef733bf5c92a464914cae543a86021d0b6bbbef6dffbc439f6ee7
+  metadata.gz: 6e22c3008961610bb37e82ece2372c4b66899a0990d93164cdbbc16620e44958fe26571075ac1ade583391a7d13a3f04792efae5a710f3ba14a778e9c520be88
+  data.tar.gz: d23c983e988c45bf0a3e4b438c29e72b391c8af559b6f1d448479dbe91a9637c0c0c35de8e7a57eb157720e68f30461ab8f6e6ffd36a76d611d753337c98dba4

data/Gemfile.lock

@@ -1,59 +1,59 @@
 PATH
   remote: .
   specs:
-    liveness (0.2.2)
+    liveness (0.3.2)
       rack (>= 1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
-    bundler-audit (0.9.0.1)
+    bundler-audit (0.9.1)
       bundler (>= 1.2.0, < 3)
       thor (~> 1.0)
     childprocess (4.1.0)
     diff-lcs (1.5.0)
     docile (1.4.0)
     iniparse (1.5.0)
-    overcommit (0.58.0)
+    overcommit (0.59.1)
       childprocess (>= 0.6.3, < 5)
       iniparse (~> 1.4)
       rexml (~> 3.2)
-    parallel (1.21.0)
-    parser (3.1.0.0)
+    parallel (1.22.1)
+    parser (3.1.2.0)
       ast (~> 2.4.1)
-    rack (2.2.3)
+    rack (2.2.3.1)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.2.0)
+    regexp_parser (2.4.0)
     rexml (3.2.5)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.3)
-    rubocop (1.24.1)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.30.0)
       parallel (~> 1.10)
-      parser (>= 3.0.0.0)
+      parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.15.1, < 2.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.18.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.15.1)
-      parser (>= 3.0.1.1)
+    rubocop-ast (1.18.0)
+      parser (>= 3.1.1.0)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    rubocop-rspec (2.7.0)
+    rubocop-rspec (2.11.1)
       rubocop (~> 1.19)
     ruby-progressbar (1.11.0)
     simplecov (0.21.2)
@@ -61,12 +61,13 @@ GEM
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
-    simplecov_json_formatter (0.1.3)
+    simplecov_json_formatter (0.1.4)
     thor (1.2.1)
     unicode-display_width (2.1.0)
 
 PLATFORMS
   x86_64-darwin-20
+  x86_64-darwin-21
   x86_64-linux
 
 DEPENDENCIES
@@ -81,4 +82,4 @@ DEPENDENCIES
   simplecov
 
 BUNDLED WITH
-   2.2.32
+   2.3.14

data/README.md

@@ -1,4 +1,5 @@
-# Liveness
+Liveness [![Ruby](https://github.com/elct9620/liveness/actions/workflows/main.yml/badge.svg)](https://github.com/elct9620/liveness/actions/workflows/main.yml)
+===
 
 The Rack middleware to provide health check endpoints.
 
@@ -28,6 +29,23 @@ Liveness.config do |c|
   c.add :postgres, name: :read_replica, timeout: 10
 end
 ```
+### Access Protected
+
+```ruby
+Liveness.config do |c|
+  c.token = 'unm@tnh8ugq-WAR-myr'
+end
+```
+
+To access the status endpoint should add `?token=unm@tnh8ugq-WAR-myr` params to access it.
+
+```ruby
+Liveness.config do |c|
+  c.ip_whitelist = ['192.168.0.0/24']
+end
+```
+
+To access the status endpoint should called from `127.0.0.1` or `::1` or under `192.168.0.0/24`.
 
 ### Customize Connector
 

data/lib/liveness/access.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require 'ipaddr'
+
+module Liveness
+  # Access Control
+  #
+  # @since 0.3.0
+  class Access
+    # @since 0.3.2
+    LOCAL_IPV4 = IPAddr.new('127.0.0.1')
+    LOCAL_IPV6 = IPAddr.new('::1')
+
+    # @param request [Rack::Request]
+    # @param config [Liveness::Config]
+    #
+    # @since 0.3.0
+    def initialize(request, config:)
+      @request = request
+      @config = config
+    end
+
+    # Is allowed to access
+    #
+    # @return [Boolean]
+    #
+    # @since 0.3.0
+    def allowed?
+      local? || (whitelist? && valid_token?)
+    end
+
+    # Is token valid
+    #
+    # @return [Boolean]
+    #
+    # @since 0.3.0
+    def valid_token?
+      return true if @config.token.nil?
+
+      @config.token == @request.params['token']
+    end
+
+    # Is from localhost
+    #
+    # @return [Boolean]
+    #
+    # @since 0.3.2
+    def local?
+      LOCAL_IPV4.include?(@request.ip) || LOCAL_IPV6.include?(@request.ip)
+    end
+
+    # Is ip in whitelist
+    #
+    # @return [Boolean]
+    #
+    # @sicne 0.3.0
+    def whitelist?
+      return true if @config.ip_whitelist.empty?
+
+      @config
+        .ip_whitelist
+        .map { |ip| IPAddr.new(ip) }
+        .reduce(true) { |curr, addr| curr & addr.include?(@request.ip) }
+    end
+  end
+end

data/lib/liveness/config.rb

@@ -8,12 +8,16 @@ module Liveness
     # @since 0.1.0
     attr_reader :dependencies
 
+    # @since 0.3.0
+    attr_accessor :token, :ip_whitelist
+
     # @return [Liveness::Config]
     #
     # @since 0.1.0
     def initialize(container: Liveness.container, &block)
       @container = container
       @dependencies = []
+      @ip_whitelist = []
 
       instance_exec(self, &block) if defined?(yield)
     end

data/lib/liveness/status.rb

@@ -12,11 +12,18 @@ module Liveness
       end
     end
 
+    # @since 0.3.0
+    HEADERS = { 'Content-Type' => 'application/json' }.freeze
+
+    # @since 0.3.0
+    FORBIDDEN_MESSAGE = { message: 'access denied' }.freeze
+
     # @return [Liveness::Status]
     #
     # @since 0.1.0
     def initialize(env, config: Liveness.config)
       @env = env
+      @request = Rack::Request.new(env)
       @config = config
     end
 
@@ -47,11 +54,23 @@ module Liveness
     #
     # @since 0.1.0
     def response
+      access = Access.new(@request, config: @config)
+      return forbidden unless access.allowed?
+
       [
         live? ? 200 : 503,
-        { 'Content-Type' => 'application/json' },
+        HEADERS.dup,
         [metrics.to_json]
       ]
     end
+
+    # @return [Rack::Response]
+    #
+    # @since 0.3.0
+    def forbidden
+      [
+        403, HEADERS.dup, [FORBIDDEN_MESSAGE.to_json]
+      ]
+    end
   end
 end

data/lib/liveness/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Liveness
-  VERSION = '0.2.2'
+  VERSION = '0.3.2'
 end

data/lib/liveness.rb

@@ -6,6 +6,7 @@ require_relative 'liveness/version'
 require_relative 'liveness/dependency'
 require_relative 'liveness/container'
 require_relative 'liveness/config'
+require_relative 'liveness/access'
 require_relative 'liveness/status'
 
 # The Rack middleware to provide health check endpoints.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: liveness
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.2
 platform: ruby
 authors:
 - 蒼時弦也
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-08 00:00:00.000000000 Z
+date: 2022-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -42,6 +42,7 @@ files:
 - bin/console
 - bin/setup
 - lib/liveness.rb
+- lib/liveness/access.rb
 - lib/liveness/config.rb
 - lib/liveness/container.rb
 - lib/liveness/dependencies.rb
@@ -73,7 +74,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.26
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: The Rack middleware to provide health check endpoints.