deploy-agent 1.3.3 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55068c8f22a5ef2219f05df92bea4a61f61b7fe50d6913bde0370e0ee57636de
-  data.tar.gz: 69c43ca34010ef2087ebb64159b6bdd65088ed73adfa5b36927e5ff10a8d9750
+  metadata.gz: c5067e76ea2bf2055765fc88baebf2b021437ea1e97fc5f58d5c077af284b6c7
+  data.tar.gz: 956efa4a5e8f55e5dfa1dc8c8fdb913b3e5b02757f374f3b4df04d4645942f91
 SHA512:
-  metadata.gz: b461ee04ef850bdf398ce0cf37ac1f888778d997d36f111fe78c0b886b1b44b7a7f26902f4bc8cecbacd2879d1fcacbed84464e2e4e9de0c9e2f89dbfd9126ba
-  data.tar.gz: c26dab5b3ccd5b9a4f65849321c4c2873c81071b38dd6bf5ac41e51e235e986cdacf925e80628c61b51900c8d1b6e68521324d8e41e6d0bc466222b7165873c1
+  metadata.gz: 66b0d717f7af4cb3e248260c76ee91a8ce02eeea02a13cc5e26de5953c80c52caf77272d226abec0c51c60a196c931a9ee70376761b888930649e51e5b5c3115
+  data.tar.gz: 71dcda3189f645a60af9b553032e40286393bb04d806802ca129cba5e035d74a525486c6407caae416bf9745f6036e1b4da523bf7c05b53a1456b7ac2a5a619b

data/ca.crt

@@ -31,3 +31,33 @@ l4CPcGbB0L8yyIhGwiEfrZpjx6hOelX1daG8QPTvSSYpB6ODtQeb3zpDf8vU8M7T
 oAwG8/0g1Owh/a970vIKu4TBa4D2IiCfA3KPWlsIUSoeu9uBTKmUQ0Raa0AhZWPv
 JI4XgcL63KznYzLm0BOxvTYMxDfn7fs=
 -----END CERTIFICATE-----
+-----BEGIN CERTIFICATE-----
+MIIFGzCCAwOgAwIBAgIBATANBgkqhkiG9w0BAQsFADAvMRowGAYDVQQDDBFEZXBs
+b3lIUSBBZ2VudCBDQTERMA8GA1UECgwIRGVwbG95SFEwHhcNMjYwOTE1MDczODI4
+WhcNMzYwOTE1MDczODI4WjAvMRowGAYDVQQDDBFEZXBsb3lIUSBBZ2VudCBDQTER
+MA8GA1UECgwIRGVwbG95SFEwggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoIC
+AQC4bMAQgGZC7ZUO9Wq2+rWodOXL4IZ6Ae+Dfce+SlTsQUx5HrYrmMFTE9NJTxcE
+dGYjAVVwpdvgT8flFKRiQa7j1xVOLr73ra7Uro0ZGHw1TOBFFAhXLZ25oXT8SsB7
+1aaRZksZAPGR1ZkWRvKqUkRge9LERtcmZDOSeKyf3i3PQp3AaODA4tRwsQnyKWoA
+6h9Ruk9jnHqNRapiEjjdkubKKRjgU28IO0Abom5dRsDvvFYVquaQmud745kdaxDr
+fQA9Kyz8lzNSglmTHACjzxtX1AGRpn5yLO7PqaV0M/QqnKZhaKW+tzP3pWdsDZ8v
+RBGDhyVYeyHYSPAEOgsRdTqQYpnXkR1FLLS/FCFQ/UgyWFStFVv3l9mzq/fQLr/O
+sdPzG9KNNTz4OqMrGOeRMcBXsKQJjIRS6TSzggPagcxT2iPRHCGQknko8/O3IyM1
+9YIsLm7kxw2oEIzhHx8Wv3s+SafJr4cuTu1n9RfyP3LmU/C6GbfrH/jDvVuLvFdH
+9AY55RNCfCgCKWjqDeYrzGxIcuoZ57H6DJlGouw0MiSg4hUUqNnM1EQG410bJouA
+itprB7FIGcZ9uHQvpEgs8NP/DTRsmUP+51Vdp6SLbFSNrt5v/APDrd3ya8R3f7g0
+XVLFl/jxNM4Ki+L6ZGwRz4SYThew0OZXsezbnYiGEro1JwIDAQABo0IwQDAdBgNV
+HQ4EFgQUgnCdcTQCEbmADry95bq7UAoX71AwDwYDVR0TAQH/BAUwAwEB/zAOBgNV
+HQ8BAf8EBAMCAQYwDQYJKoZIhvcNAQELBQADggIBAHaN63Zqs4W5FTTqQPYnkMH0
+/hMzRVVcQ8tZng6rGy4HdONixQ2XOwFOCMbl8uqRB/ihyLbwiLIVgsqG3wMEIiqV
+lxNDYerUtdBolam/lqA371d18lEqKFiFfncCRrd+AzTMcYnYZZK026smx1JCxDCP
+t1rB/T9Lv0g2aRyWTKsKBeI5GFOIEIHScP1k/R7549kNEwerFKX5USWszDfnouiV
+hSz9UjlY1vQQ//qYgimevJxlGudt2b+73+BkT5THdNKBxeyn02/DbhaH/1zafE/7
+lxAKmN94HkAOM2TD27ZPRDIK4jmKK/Hx03X0kYD+KL/9Mr/4PIjlObRFF8BUawp1
+Kpn/Caw4gNz76IujGXGvJp9FxsZUscRRRdikIZ3AtR0/6Wyf8fFaAd89DoBGSzLM
+mRynJbnK5ROlVzvxX43ow7sBLtoh1+/RCsWcCVgOC2EMCW2n4b5M0USv7FBrhPie
+F50NkMqsTtEoxw8kcKvLd4FbPvWuIxPsXzxlnFaHTbVgTevgL6O8IVeWLqdqwFGK
+owB7z1tEQTN6sV4+fDDtaVQFCalEV9QPAolVLYdBUApc866heDHmzW85tkq2zoDG
+2cj80hCcI42DPvrb9nEcIcZiFZDCcIlDjRf6kDmqBW4oXr5V1yAxrC+i0UA2+LWj
+NVgD1tDYCLJlNY3GA6j8
+-----END CERTIFICATE-----

data/deploy-agent.gemspec

@@ -1,11 +1,14 @@
 # frozen_string_literal: true
 
+require_relative 'lib/deploy_agent/version'
+
 Gem::Specification.new do |s|
   s.name        = 'deploy-agent'
-  s.version     = '1.3.3'
+  s.version     = DeployAgent::VERSION
   s.required_ruby_version = '>= 2.7'
   s.summary     = 'The DeployHQ Agent'
-  s.description = 'This gem allows you to configure a secure proxy through which DeployHQ can forward connections'
+  s.description = 'Deprecated: use https://github.com/deployhq/network-agent instead. ' \
+                  'This gem allows you to configure a secure proxy through which DeployHQ can forward connections'
   s.authors     = ['Charlie Smurthwaite']
   s.email       = ['support@deployhq.com']
   s.files       = Dir.glob('{lib,bin}/**/*')
@@ -15,7 +18,16 @@ Gem::Specification.new do |s|
   s.bindir      = 'bin'
   s.executables << 'deploy-agent'
 
-  s.add_dependency 'nio4r', '2.1.0'
-  s.add_dependency 'rb-readline', '0.5.5'
-  s.add_dependency 'timers', '4.1.2'
+  s.add_dependency 'nio4r', '~> 2.7'
+  s.add_dependency 'rb-readline', '~> 0.5'
+  # timers 4.4.0 raised required_ruby_version to >= 3.1. '~> 4.3' admits it, and the
+  # RubyGems shipped with Ruby 2.7 cannot back off to 4.3.5 on its own, so a plain
+  # `gem install deploy-agent` fails outright on every Ruby this gem still supports
+  # below 3.1. Keep the upper bound until required_ruby_version moves past 3.1.
+  s.add_dependency 'timers', '>= 4.3', '< 4.4'
+
+  s.post_install_message = <<~MSG
+    WARNING: deploy-agent is deprecated and only receives essential fixes.
+    Please migrate to the new agent: https://github.com/deployhq/network-agent
+  MSG
 end

data/lib/deploy_agent/agent.rb

@@ -1,5 +1,3 @@
-gem 'nio4r', '2.1.0'
-gem 'timers', '4.1.2'
 require 'nio'
 require 'timers'
 require 'logger'

data/lib/deploy_agent/certificate_renewal.rb

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+require 'openssl'
+
+module DeployAgent
+  # Validates and atomically installs a replacement client certificate offered by
+  # the Deploy server over the tunnel (see ServerConnection::COMMAND_RENEW_RESPONSE).
+  #
+  # A renewal is a re-signature of the certificate we already hold: the server
+  # re-signs our stored public key under a different CA, keeping the subject and
+  # the serial. Our private key is never involved, so a renewed certificate must
+  # still pair with the agent.key already on disk.
+  #
+  # Every check runs before anything touches the filesystem, and the replacement
+  # is swapped in with rename(2). A bad agent.crt is not a recoverable state: the
+  # agent would fail the TLS handshake on every reconnect and Agent#run gives up
+  # and exits the process after four consecutive SSL errors.
+  class CertificateRenewal
+
+    class InvalidCertificate < StandardError; end
+
+    def initialize(certificate_path: CERTIFICATE_PATH, key_path: KEY_PATH, ca_path: CA_PATH)
+      @certificate_path = certificate_path
+      @key_path = key_path
+      @ca_path = ca_path
+    end
+
+    # Validate a PEM-encoded replacement certificate and install it.
+    #
+    # Returns the installed OpenSSL::X509::Certificate, or nil when the server
+    # offered the certificate we are already using (in which case nothing is
+    # written and there is no reason to reconnect).
+    #
+    # Raises InvalidCertificate - having written nothing at all - if any check
+    # fails. The caller keeps its working certificate.
+    def install(pem)
+      new_certificate = parse(pem)
+      validate!(new_certificate)
+      return nil if new_certificate.to_der == current_certificate.to_der
+
+      write(new_certificate)
+      new_certificate
+    end
+
+    private
+
+    def parse(pem)
+      raise InvalidCertificate, 'renewal response contained no certificate' if pem.nil? || pem.empty?
+
+      OpenSSL::X509::Certificate.new(pem)
+    rescue OpenSSL::OpenSSLError => e
+      raise InvalidCertificate, "could not parse the offered certificate: #{e.message}"
+    end
+
+    def validate!(new_certificate)
+      # Renewal re-signs our public key, it never re-keys us, so the replacement
+      # has to pair with the private key we already hold.
+      unless new_certificate.check_private_key(private_key)
+        raise InvalidCertificate, 'offered certificate does not match the agent private key'
+      end
+
+      # The backend identifies this agent by the certificate serial, and the
+      # subject carries the agent name. Neither may change across a renewal.
+      unless new_certificate.subject == current_certificate.subject
+        raise InvalidCertificate,
+              "offered certificate has a different subject (#{current_certificate.subject} -> #{new_certificate.subject})"
+      end
+
+      unless new_certificate.serial == current_certificate.serial
+        raise InvalidCertificate,
+              "offered certificate has a different serial (#{current_certificate.serial} -> #{new_certificate.serial})"
+      end
+
+      # And it has to chain to a CA we ship *as a TLS client certificate*, or we
+      # would be trading a working certificate for one the server refuses on the
+      # next handshake - and every handshake after it.
+      store = certificate_store
+      return if store.verify(new_certificate)
+
+      raise InvalidCertificate, "offered certificate is not a usable client certificate (#{store.error_string})"
+    end
+
+    # Write to a private temporary file in the same directory, flush it all the
+    # way to disk, then rename over agent.crt so a reader never sees a partial
+    # certificate and a crash mid-write cannot destroy the working one.
+    def write(certificate)
+      temp_path = temporary_path
+      begin
+        File.open(temp_path, File::WRONLY | File::CREAT | File::EXCL, 0o600) do |file|
+          file.write(certificate.to_pem)
+          file.flush
+          file.fsync
+        end
+        File.rename(temp_path, @certificate_path)
+      rescue StandardError
+        File.unlink(temp_path) if File.file?(temp_path)
+        raise
+      end
+    end
+
+    def temporary_path
+      directory = File.dirname(@certificate_path)
+      basename = File.basename(@certificate_path)
+      File.join(directory, ".#{basename}.#{Process.pid}.#{rand(0xffffffff).to_s(16)}")
+    end
+
+    def current_certificate
+      @current_certificate ||= OpenSSL::X509::Certificate.new(File.read(@certificate_path))
+    rescue SystemCallError, OpenSSL::OpenSSLError => e
+      raise InvalidCertificate, "could not read the current certificate: #{e.message}"
+    end
+
+    def private_key
+      @private_key ||= OpenSSL::PKey::RSA.new(File.read(@key_path))
+    rescue SystemCallError, OpenSSL::OpenSSLError => e
+      raise InvalidCertificate, "could not read the agent private key: #{e.message}"
+    end
+
+    def certificate_store
+      @certificate_store ||= OpenSSL::X509::Store.new.tap do |store|
+        store.add_file(@ca_path)
+        # The agent presents this certificate for TLS client authentication, so
+        # verify it for that purpose rather than the store's default, which
+        # accepts anything that merely chains. Real agent certificates carry no
+        # extensions at all and this purpose accepts them; what it rejects is a
+        # certificate whose keyUsage or extendedKeyUsage rules client auth out
+        # (a serverAuth-only certificate, say), which would otherwise install
+        # cleanly and then be refused by the server on every reconnect.
+        store.purpose = OpenSSL::X509::PURPOSE_SSL_CLIENT
+      end
+    rescue SystemCallError, OpenSSL::OpenSSLError => e
+      raise InvalidCertificate, "could not read the CA bundle: #{e.message}"
+    end
+
+  end
+end

data/lib/deploy_agent/cli.rb

@@ -4,7 +4,20 @@ require 'optparse'
 module DeployAgent
   class CLI
 
+    DEPRECATION_NOTICE = <<~MSG
+      \e[33m╔══════════════════════════════════════════════════════════════════╗
+      ║  DEPRECATED: deploy-agent only receives essential fixes.         ║
+      ║  Please migrate to the new agent:                                ║
+      ║                                                                  ║
+      ║    https://github.com/deployhq/network-agent                     ║
+      ║                                                                  ║
+      ║  Fewer dependencies, easier to install.                          ║
+      ╚══════════════════════════════════════════════════════════════════╝\e[0m
+    MSG
+
     def dispatch(arguments)
+      warn DEPRECATION_NOTICE
+
       methods = self.public_methods(false).delete_if { |n| n == :dispatch }.sort
 
       @options = {}
@@ -13,7 +26,7 @@ module DeployAgent
         opts.on('-v', '--verbose', 'Log extra debug information') do
           @options[:verbose] = true
         end
-      end.parse!
+      end.parse!(arguments)
 
       if arguments[0] && methods.include?(arguments[0].to_sym)
         public_send(arguments[0])

data/lib/deploy_agent/server_connection.rb

@@ -9,6 +9,17 @@ module DeployAgent
     attr_reader :destination_connections, :agent
     attr_writer :nio_monitor
 
+    # Tunnel commands. 1-7 are the original proxy protocol. 8 and 9 were added
+    # for in-band certificate renewal and are implemented identically in the Go
+    # agent (network-agent) and in the backend.
+    COMMAND_RENEW_REQUEST  = 8 # agent -> server, payload "ruby/<version>"
+    COMMAND_RENEW_RESPONSE = 9 # server -> agent, payload [status:1][body]
+
+    # COMMAND_RENEW_RESPONSE statuses
+    RENEW_STATUS_RENEWED = 0 # body is the replacement certificate, PEM encoded
+    RENEW_STATUS_CURRENT = 1 # no body, the certificate we hold is current
+    RENEW_STATUS_ERROR   = 2 # body is a UTF-8 message
+
     # Create a secure TLS connection to the Deploy server
     def initialize(agent, server_host, nio_selector, check_certificate=true)
       @agent = agent
@@ -40,6 +51,12 @@ module DeployAgent
       @nio_monitor = @nio_selector.register(@tcp_socket, :r)
       @nio_monitor.value = self
 
+      # Ask the server whether a replacement certificate is waiting for us. The
+      # server decides and answers with COMMAND_RENEW_RESPONSE; it never sends one
+      # unsolicited. This has to come after the monitor exists because send_packet
+      # arms it for writing.
+      request_certificate_renewal
+
       @agent.logger.info "Successfully connected to server"
     rescue => e
       @agent.logger.info "Something went wrong connecting to server."
@@ -111,6 +128,9 @@ module DeployAgent
           # This is a shutdown request. Disconnect and don't re-attempt connection.
           @agent.logger.warn "Server requested reconnect. Closing connection."
           close
+        when COMMAND_RENEW_RESPONSE
+          # The server has answered our renewal request.
+          handle_renewal_response(packet[1..-1])
         end
       end
     rescue EOFError, Errno::ECONNRESET, Errno::ETIMEDOUT, Errno::ENETRESET
@@ -183,6 +203,48 @@ module DeployAgent
       raise ServerDisconnected
     end
 
+    # Ask the server to re-issue our client certificate, telling it which agent
+    # implementation and version is asking. Renewal is best effort: it must never
+    # stop us connecting, so a failure here is logged and otherwise ignored.
+    def request_certificate_renewal
+      @agent.logger.debug "Requesting certificate renewal"
+      send_packet([COMMAND_RENEW_REQUEST, "ruby/#{DeployAgent::VERSION}"].pack('Ca*'))
+    rescue => e
+      @agent.logger.warn "Could not request certificate renewal: #{e.message}"
+    end
+
+    # Process a COMMAND_RENEW_RESPONSE. Renewal must never take the agent down, so
+    # anything unexpected is logged and the existing certificate is kept.
+    def handle_renewal_response(body)
+      body = body.to_s
+      status = body.bytes[0]
+      payload = body[1..-1].to_s
+
+      case status
+      when RENEW_STATUS_RENEWED
+        certificate = CertificateRenewal.new.install(payload)
+        if certificate
+          @agent.logger.info "Certificate renewed (issuer=#{certificate.issuer})"
+          # Reconnect so the new certificate is the one we present. close raises
+          # ServerDisconnected, which Agent#run catches and retries, and the new
+          # connection re-reads agent.crt from disk.
+          close
+        else
+          @agent.logger.debug "Server offered the certificate we already hold"
+        end
+      when RENEW_STATUS_CURRENT
+        @agent.logger.debug "Certificate is up to date"
+      when RENEW_STATUS_ERROR
+        @agent.logger.warn "Server could not renew our certificate: #{payload}"
+      else
+        @agent.logger.warn "Unknown certificate renewal status: #{status.inspect}"
+      end
+    rescue ServerDisconnected
+      raise
+    rescue => e
+      @agent.logger.warn "Certificate renewal failed: #{e.message}"
+    end
+
     # Queue a packet of data to be sent to the Deploy server
     def send_packet(data)
       @tx_buffer << [data.bytesize+2, data].pack('na*')

data/lib/deploy_agent/version.rb

@@ -1,17 +1,5 @@
-require "rubygems"
+# frozen_string_literal: true
 
 module DeployAgent
-  VERSION_FILE_PATH = File.expand_path('../../../VERSION', __FILE__)
-  SPEC_FILE_PATH    = File.expand_path('../../../deploy-agent.gemspec', __FILE__)
-
-  if File.file?(VERSION_FILE_PATH)
-    VERSION = File.read(VERSION_FILE_PATH).strip.sub(/\Av/, '')
-  elsif File.file?(SPEC_FILE_PATH)
-    VERSION = Gem::Specification::load(SPEC_FILE_PATH).version.to_s
-  else
-    puts __FILE__
-
-    VERSION = '0.0.0.dev'
-  end
-
+  VERSION = '1.5.0'
 end

data/lib/deploy_agent.rb

@@ -1,4 +1,5 @@
 require 'deploy_agent/version'
+require 'deploy_agent/certificate_renewal'
 require 'deploy_agent/configuration_generator'
 require 'deploy_agent/server_connection'
 require 'deploy_agent/destination_connection'

metadata

@@ -1,58 +1,64 @@
 --- !ruby/object:Gem::Specification
 name: deploy-agent
 version: !ruby/object:Gem::Version
-  version: 1.3.3
+  version: 1.5.0
 platform: ruby
 authors:
 - Charlie Smurthwaite
 bindir: bin
 cert_chain: []
-date: 2025-01-08 00:00:00.000000000 Z
+date: 2026-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nio4r
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: '2.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: '2.7'
 - !ruby/object:Gem::Dependency
   name: rb-readline
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.5
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.5
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: timers
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 4.1.2
+        version: '4.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.3'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 4.1.2
-description: This gem allows you to configure a secure proxy through which DeployHQ
-  can forward connections
+        version: '4.4'
+description: 'Deprecated: use https://github.com/deployhq/network-agent instead. This
+  gem allows you to configure a secure proxy through which DeployHQ can forward connections'
 email:
 - support@deployhq.com
 executables:
@@ -65,6 +71,7 @@ files:
 - deploy-agent.gemspec
 - lib/deploy_agent.rb
 - lib/deploy_agent/agent.rb
+- lib/deploy_agent/certificate_renewal.rb
 - lib/deploy_agent/cli.rb
 - lib/deploy_agent/configuration_generator.rb
 - lib/deploy_agent/destination_connection.rb
@@ -73,6 +80,9 @@ files:
 homepage: https://www.deployhq.com/
 licenses: []
 metadata: {}
+post_install_message: |
+  WARNING: deploy-agent is deprecated and only receives essential fixes.
+  Please migrate to the new agent: https://github.com/deployhq/network-agent
 rdoc_options: []
 require_paths:
 - lib