sparoid 1.0.7 → 1.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a97b0d586778f3f851e5c42039bffaf461bb2e8927d9fea86cd69c8cfa0e1e9
-  data.tar.gz: b66ff9a2c806838408c546d38c3698c7bc5334d3b11aba00d1e4de8f9e848f05
+  metadata.gz: 12dad3dbab45bb38650465dab2b26f356c051569b06d20ba1bcfd6af11eb9701
+  data.tar.gz: 0b17fe457b36978f1b682153cb14578192cb657a846fadcbb3abb2cf82e07bb6
 SHA512:
-  metadata.gz: 1f2643b8599ab7c78e30b3e6927ad79e405becebfa8cfe617a0d7245e82ec4d0b11c9fcbf9cff2365403b59d2472260b4ab8b290e897991d8f3e6b1b19736e1e
-  data.tar.gz: '048ecd5b85d177c044626fb11cf304fbbc14b906d366566e34c7afa535ec419ba4b8a9369108ab67fc121496908e4a3ac0f42a2821db723bb7771a46ab26ab7e'
+  metadata.gz: 1c31f7b1fa30e2d064b0e92e79b2b567bdfa4021995d7f52c25b6b4373d08062ed091aab8187aeb42051c11e0c7c1b994d158878e64311eed28e68d1e3fe4008
+  data.tar.gz: cacd2adf45ed9fa8e31b063809e01cf0371c6d13670e24b5bdb17f7c2623c2f9592c7e38b6df18a5f529db9628d4197baf323a9d58124b8eb6ea75762c3a6d78

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 2.5
   NewCops: enable
 
 Style/StringLiterals:

data/CHANGELOG.md

@@ -1,3 +1,24 @@
+## [1.0.12] - 2021-06-14
+
+- Use file locking to prevent multiple processes/threads to write to the public ip cache file
+
+## [1.0.11] - 2021-06-14
+
+- Log hostname when reporting unhandled exceptions
+
+## [1.0.10] - 2021-06-09
+
+- Cache public IP in /tmp/.sparoid_public_ip for 1 min
+
+## [1.0.9] - 2021-05-23
+
+- Exit gracefully on abort (ctrl-c) instead of dumping huge stacktrace
+- Sleep 20ms aftering sending UDP package to allow for remote host to open its firewall
+
+## [1.0.8] - 2021-04-27
+
+- Get ENV variables if config file is missing
+
 ## [1.0.7] - 2021-04-27
 
 - Get key and hmac key from ENV variables

data/README.md

@@ -26,7 +26,7 @@ Can be used with OpenSSH's ProxyCommand/ProxyUseFdpass to send the packet before
 
 ```
 Host *.example.com
-  ProxyCommand sparoid send %h --passfd %p
+  ProxyCommand sparoid connect %h %p
   ProxyUseFdpass yes
 ```
 

data/exe/sparoid

@@ -1,5 +1,9 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require_relative "../lib/sparoid/cli"
-Sparoid::CLI.start
+begin
+  require_relative "../lib/sparoid/cli"
+  Sparoid::CLI.start
+rescue Interrupt
+  exit 1
+end

data/lib/sparoid.rb

@@ -11,9 +11,14 @@ module Sparoid
 
   # Send an authorization packet
   def auth(key, hmac_key, host, port)
-    msg = message(public_ip)
+    msg = message(cached_public_ip)
     data = prefix_hmac(hmac_key, encrypt(key, msg))
     sendmsg(host, port, data)
+
+    # wait some time for the server to actually open the port
+    # if we don't wait the next SYN package will be dropped
+    # and it have to be redelivered, adding 1 second delay
+    sleep 0.02
   end
 
   # Generate new aes and hmac keys, print to stdout
@@ -67,7 +72,42 @@ module Sparoid
     version = 1
     ts = (Time.now.utc.to_f * 1000).floor
     nounce = OpenSSL::Random.random_bytes(16)
-    [version, ts, nounce, ip.address].pack("Nq>a16a4")
+    [version, ts, nounce, ip.address].pack("N q> a16 a4")
+  end
+
+  def cached_public_ip
+    if up_to_date_cache?
+      read_cache
+    else
+      write_cache
+    end
+  rescue StandardError => e
+    warn "Sparoid: #{e.inspect}"
+    public_ip
+  end
+
+  def up_to_date_cache?
+    mtime = File.mtime("/tmp/.sparoid_public_ip")
+    (Time.now - mtime) <= 60 # cache is valid for 1 min
+  rescue Errno::ENOENT
+    false
+  end
+
+  def read_cache
+    File.open("/tmp/.sparoid_public_ip", "r") do |f|
+      f.flock(File::LOCK_SH)
+      Resolv::IPv4.create f.read
+    end
+  end
+
+  def write_cache
+    File.open("/tmp/.sparoid_public_ip", File::WRONLY | File::CREAT, 0o0644) do |f|
+      f.flock(File::LOCK_EX)
+      ip = public_ip
+      f.truncate(0)
+      f.write ip.to_s
+      ip
+    end
   end
 
   def public_ip

data/lib/sparoid/cli.rb

@@ -13,7 +13,7 @@ module Sparoid
     rescue Errno::ENOENT
       abort "Sparoid: Config not found"
     rescue StandardError => e
-      abort "Sparoid: #{e.message}"
+      abort "Sparoid: #{e.message} (#{host})"
     end
 
     desc "connect HOST PORT [SPA-PORT]", "Send a SPA, TCP connect, and then pass the FD back to the parent"
@@ -26,7 +26,7 @@ module Sparoid
       end
       Sparoid.fdpass(host, port)
     rescue StandardError => e
-      abort "Sparoid: #{e.message}"
+      abort "Sparoid: #{e.message} (#{host})"
     end
 
     desc "keygen", "Generate an encryption key and a HMAC key"
@@ -41,14 +41,17 @@ module Sparoid
     private
 
     def send_auth(host, port, config)
-      key = ENV["SPAROID_KEY"]
-      hmac_key = ENV["SPAROID_HMAC_KEY"]
-      key, hmac_key = get_keys(parse_ini(config)) if config
+      key, hmac_key = get_keys(parse_ini(config))
       Sparoid.auth(key, hmac_key, host, port.to_i)
     end
 
     def parse_ini(path)
       File.readlines(File.expand_path(path)).map! { |line| line.split("=", 2).map!(&:strip) }.to_h
+    rescue Errno::ENOENT
+      {
+        "key" => ENV["SPAROID_KEY"],
+        "hmac-key" => ENV["SPAROID_HMAC_KEY"]
+      }
     end
 
     def get_keys(config)

data/lib/sparoid/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Sparoid
-  VERSION = "1.0.7"
+  VERSION = "1.0.12"
 end

data/sparoid.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.summary       = "Single Packet Authorisation client"
   spec.homepage      = "https://github.com/84codes/sparoid.rb"
   spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sparoid
 version: !ruby/object:Gem::Version
-  version: 1.0.7
+  version: 1.0.12
 platform: ruby
 authors:
 - Carl Hörberg
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-27 00:00:00.000000000 Z
+date: 2021-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -62,14 +62,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.2.15
 signing_key:
 specification_version: 4
 summary: Single Packet Authorisation client