sparoid 1.0.8 → 1.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c8737279c5f4eae1d6b5c38e14fc6d43ec3978bb445196a2873dbcb24c33146
-  data.tar.gz: 72b1d744ecac0c6afa993b7365f2023ba17d6306ee64d58ae5a27378d082f667
+  metadata.gz: 1f5904f6b6c520213811268420efad5fd5a387942352d8def32b722cd14420da
+  data.tar.gz: 6f7e19f1515979078635ff1e862bc9bcbb6fb2172ac631d94b986dd1b95984fb
 SHA512:
-  metadata.gz: 671a2b3ad5df6752f29f5de76c6e3f1613088b75406d187154a4be4da514b93e1c0a9ee19b99c430133321029db3f088565d917860f9794ef15558c467ed2532
-  data.tar.gz: 57d624c615d9067eaa2d4fd6f23fe3d5213b953674b00738da08f995b917244fb85fb8e1bddf3ccd0013b292a5101ade4014b9da1b5155a35c2d78732ce5c7b6
+  metadata.gz: 6043c439103ae404d9dfc6855b0273777b3e1e505d768e36b7d5bf514abc6c2a0498ecda76ddf89994d4d3fb426394fc3994566e659842e377bab643b8edfcfd
+  data.tar.gz: d95a3908952eb8134f1c68bd22a6f13f05ca99a8f1bda888c0adf6cbc77e882f65e4097a12b3db8a28ec74c624d8cee0821827ee12e54953da567606605f1e96

data/.rubocop.yml

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

data/CHANGELOG.md

@@ -1,3 +1,25 @@
+## [1.0.13] - 2021-06-30
+
+- Do not warn on empty public ip cache file
+- The public ip cache file path can be controlled using the `SPAROID_CACHE_PATH` environment variable
+
+## [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

data/Gemfile

@@ -5,12 +5,9 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in sparoid.gemspec
 gemspec
 
-gem "rake", "~> 13.0"
-
 gem "minitest", "~> 5.0"
-
+gem "minitest-stub-const"
+gem "rake", "~> 13.0"
 gem "rubocop", "~> 1.7"
-
 gem "rubocop-minitest", require: false
-
 gem "rubocop-rake", require: false

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

@@ -9,11 +9,18 @@ require "resolv"
 module Sparoid
   extend self
 
+  SPAROID_CACHE_PATH = ENV.fetch("SPAROID_CACHE_PATH", "/tmp/.sparoid_public_ip")
+
   # 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 +74,46 @@ 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(SPAROID_CACHE_PATH)
+    (Time.now - mtime) <= 60 # cache is valid for 1 min
+  rescue Errno::ENOENT
+    false
+  end
+
+  def read_cache
+    File.open(SPAROID_CACHE_PATH, "r") do |f|
+      f.flock(File::LOCK_SH)
+      Resolv::IPv4.create f.read
+    end
+  rescue ArgumentError => e
+    return write_cache if e.message =~ /cannot interpret as IPv4 address/
+
+    raise e
+  end
+
+  def write_cache
+    File.open(SPAROID_CACHE_PATH, 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"

data/lib/sparoid/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Sparoid
-  VERSION = "1.0.8"
+  VERSION = "1.0.13"
 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.8
+  version: 1.0.13
 platform: ruby
 authors:
 - Carl Hörberg
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-27 00:00:00.000000000 Z
+date: 2021-06-30 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.1.6
 signing_key:
 specification_version: 4
 summary: Single Packet Authorisation client