netpump 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 298b321a2b63596d5247b8d8cd807722c5062249f8f2c9e1b44b30b030a528f3
-  data.tar.gz: c534a39e90383b0ac3896c8060d233dbd02c26c83563ed7d8c9d331b81c91370
+  metadata.gz: 6931a624fa28d354c72f47c02c06fe7041784c0a7f31668e66099d3fd3ee37e8
+  data.tar.gz: f9a71688a43c7fee6ba692cabd7f3b7903ebdd40388c762f0b643c6e80f0767e
 SHA512:
-  metadata.gz: 95a11534001077454e72c94f94c81a2e816b613f9ab643ebaaeb06bbcf3e40f7210799130457d0af56677d2c0e5ac73ff8701426f778551c837f5b0ef9c3c711
-  data.tar.gz: c0a4abe22639b9667cdfdf879f63a2c05e96c8ed3eac0d3376506b3d2e094724d5c18933ca9464ad099a87560545dbac91a55324ee82707f337d3eb2cf3a567c
+  metadata.gz: 25589fad75f1b12458b5b83273ffae665ab1cf4a31badeb1714d611f20e29de4a97567f06fe9472538021e95ca9bfd7dfbdf20665781c3a08fd3e60091dd54a5
+  data.tar.gz: ef0cfa5f786bc386f589d0fd9612a5165ae4051827a6b9b0e3e5561baee74da3cc9247eccfafed53610532436ea02795013c457e320da701aa295ffaed28f841

data/CHANGELOG

@@ -1,10 +1,27 @@
+1.0.2
+
+Simplify argv parsing code
+Downcase websocket handshake headers
+Add test case for invalid server requests
+Update public np server address
+Allow any base path in remote server URL
+Stop on SIGTERM
+
+1.0.1
+
+Simplify sequential and parallel request tests
+Dump backtrace only if $VERBOSE is true
+Manage $LOAD_PATH externally
+Abort on unhandled exception
+
 1.0.0
 
-* Add backpressure mechanism to keep memory usage bounded
+* Rename weblink to netpump
+* Add direct client mode, where client connects to the server directly
+* Add backpressure handling to keep memory usage low and bounded
 * Add websocket pool timeout
 * Add more unbind reasons
 * Add option to set the server URL, remove the server query param
-* Add direct client mode
 
 1.3.0
 

data/bin/netpump

@@ -2,12 +2,7 @@
 
 Process.setproctitle "netpump"
 $stdin.close
-if $PROGRAM_NAME.include?("/")
-  $VERBOSE = true
-  $LOAD_PATH.unshift File.expand_path("../lib", __dir__)
-else
-  $VERBOSE = nil
-end
+$VERBOSE = $PROGRAM_NAME == __FILE__ || nil
 
 require "optparse"
 require "uri"
@@ -17,8 +12,8 @@ copts = {}
 sopts = {}
 
 op = OptionParser.new do |op|
+  op.version = "1.0.2"
   op.summary_width = 24
-
   op.banner = "Usage: netpump [options]"
   op.separator ""
   op.separator "Options:"
@@ -39,15 +34,15 @@ op = OptionParser.new do |op|
     raise OptionParser::InvalidArgument, val
   end
 
-  op.on("-c", "--client MODE", ["direct", "browser"], "start netpump client (mode: direct, browser)") do |mode|
+  op.on("-c", "--client MODE", ["direct", "browser"], "start np client (mode: direct, browser)") do |mode|
     copts[:mode] = mode
   end
 
-  op.on("--client-host HOST", String, "client host (default: 0.0.0.0)") do |host|
+  op.on("--client-host HOST", String, "np client host (default: 0.0.0.0)") do |host|
     copts[:host] = host
   end
 
-  op.on("--client-port PORT", Port, "client port (default: 8080)") do |port|
+  op.on("--client-port PORT", Port, "np client port (default: 8080)") do |port|
     copts[:port] = port
   end
 
@@ -59,32 +54,21 @@ op = OptionParser.new do |op|
     copts[:proxy_port] = port
   end
 
-  op.on("--server-url URL", WSS, "netpump server url (example: wss://example.org)") do |url|
+  op.on("--server-url URL", WSS, "remote np server url (default: wss://s.netpump.org)") do |url|
     copts[:server_url] = url
   end
 
-  op.on("-s", "--server", "start netpump server") do
+  op.on("-s", "--server", "start np server") do
     sopts[:server] = true
   end
 
-  op.on("--server-host HOST", String, "server host (default: 0.0.0.0)") do |host|
+  op.on("--server-host HOST", String, "np server host (default: 0.0.0.0)") do |host|
     sopts[:host] = host
   end
 
-  op.on("--server-port PORT", Port, "server port (default: 10000)") do |port|
+  op.on("--server-port PORT", Port, "np server port (default: 10000)") do |port|
     sopts[:port] = port
   end
-
-  op.on_tail("--version", "print version") do
-    version = File.expand_path("../VERSION", __dir__)
-    puts(File.read(version))
-    exit
-  end
-
-  op.on_tail("--help", "print this help") do
-    puts(op)
-    exit
-  end
 end
 
 begin
@@ -97,9 +81,13 @@ else
   end
 end
 
-EventMachine.error_handler { |e| log "[!] unexpected errback.", error: e }
+EventMachine.error_handler do |e|
+  log "[!] error: #{e.message}."
+  EventMachine.stop
+end
 EventMachine.run do
   trap(:INT) { puts; EventMachine.stop }
+  trap(:TERM) { EventMachine.stop }
   if sopts.delete(:server)
     server = Netpump::Server.new(**sopts)
     server.start
@@ -108,7 +96,4 @@ EventMachine.run do
     client = Netpump::Client.new(**copts)
     client.start
   end
-rescue => e
-  log "[!] #{e.message}."
-  EventMachine.stop
 end

data/lib/eventmachine/websocket/client.rb

@@ -17,10 +17,14 @@ module EventMachine::WebSocket
       @parser.on_headers_complete = proc do
         headers = @parser.headers
         @parser = nil
-        accept = Digest::SHA1.base64digest(@key + "258EAFA5-E914-47DA-95CA-C5AB0DC85B11")
-        unless headers["Connection"]&.downcase == "upgrade" &&
-            headers["Upgrade"]&.downcase == "websocket" &&
-            headers["Sec-WebSocket-Accept"] == accept
+        headers.transform_keys!(&:downcase)
+        con = headers["connection"]
+        con&.downcase!
+        upg = headers["upgrade"]
+        upg&.downcase!
+        acc = headers["sec-websocket-accept"]
+        acc_ = Digest::SHA1.base64digest(@key + "258EAFA5-E914-47DA-95CA-C5AB0DC85B11")
+        unless con == "upgrade" && upg == "websocket" && acc == acc_
           raise HandshakeError, "Invalid server handshake"
         end
         debug [:handshake_completed]

data/lib/eventmachine/websocket/server.rb

@@ -34,7 +34,7 @@ module EventMachine::WebSocket::Server
 
       def ws.serve_file(path)
         send_data("HTTP/1.1 200 OK\r\n\r\n")
-        # win: send/stream_file_data do not work on windows
+        # windows: send/stream_file_data do not work
         send_data(path.read)
         close_connection_after_writing
       end

data/lib/netpump/client.rb

@@ -15,14 +15,19 @@ module Netpump
       port: "8080",
       proxy_host: "127.0.0.1",
       proxy_port: 3128,
-      server_url: "wss://weblink-ouux.onrender.com",
+      server_url: "wss://s.netpump.org",
       connection_inactivity_timeout: 30.0,
       websocket_pool_size: 20,
       websocket_pool_timeout: 60.0
     )
       @mode = mode
-      @host = host
-      @port = port
+      if mode == "browser"
+        @host = host
+        @port = port
+      else
+        @host = nil
+        @port = nil
+      end
       @proxy_host = proxy_host
       @proxy_port = proxy_port
       @server_url = URI(server_url)
@@ -31,12 +36,14 @@ module Netpump
       @websocket_pool_size = websocket_pool_size
       @websocket_pool_timeout = websocket_pool_timeout
       @control_ws = nil
-      @log = lambda { |msg, **ctx| log(msg, loc: true, **ctx) }
+      @log = lambda { |msg, **ctx| log(msg, c: true, **ctx) }
       @ready = EventMachine::Completion.new
+      @ready.callback do
+        @log.call "[+] np client is ready.", mode: @mode, host: @host, port: @port
+      end
     end
 
     def start
-      @log.call "[+] netpump client is starting.", mode: @mode, host: @host, port: @port
       case @mode
       when "direct"
         start_proxy_server
@@ -58,10 +65,10 @@ module Netpump
         case path
         when "/"
           ws.serve_file(PUBLIC_DIR.join("netpump.html"))
-          @log.call "[~] http request.", method: "GET", path: path, ip: ws.remote_ip
+          @log.call "[~] http request.", ip: ws.remote_ip, method: "GET", path: path
         when "/favicon.svg"
           ws.serve_file(PUBLIC_DIR.join("favicon.svg"))
-          @log.call "[~] http request.", method: "GET", path: path, ip: ws.remote_ip
+          @log.call "[~] http request.", ip: ws.remote_ip, method: "GET", path: path
         when "/ws/loc/control"
           next false if @control_ws
           ws.onopen do |_handshake|
@@ -73,7 +80,7 @@ module Netpump
               @control_ws = nil
               @log.call "[-] device is disconnected.", sig: ws.signature
               EventMachine.stop_server(proxy)
-              @log.call "[-] proxy server is stopped."
+              @log.call "[-] np proxy server is stopped."
             end
             @ready.succeed
           end
@@ -100,10 +107,10 @@ module Netpump
     end
 
     def start_proxy_server
-      proxy = EventMachine.start_server(@proxy_host, @proxy_port, Relay, "loc") do |relay|
+      proxy = EventMachine.start_server(@proxy_host, @proxy_port, Relay, "c") do |relay|
         bind(relay)
       end
-      @log.call "[+] proxy server is ready.", type: "https", host: @proxy_host, port: @proxy_port
+      @log.call "[+] np proxy server is ready.", type: "https", host: @proxy_host, port: @proxy_port
       proxy
     end
 

data/lib/netpump/log.rb

@@ -7,7 +7,7 @@ def log(msg, **context)
     case v
     when Exception
       line << " #{k}=#{v.message.inspect}"
-      line << " backtrace=#{v.backtrace}" if !$VERBOSE.nil? && v.backtrace
+      line << " backtrace=#{v.backtrace}" if $VERBOSE && v.backtrace
     when true
       line << " #{k}"
     when false, nil, ""

data/lib/netpump/relay.rb

@@ -34,10 +34,11 @@ module Netpump
       @remote_ip = remote_ip
       @connection_inactivity_timeout = comm_inactivity_timeout
       if @closed
-        # If a connection is closed due to the pool timeout before being bound to
-        # a websocket, it is not added to the wait queue in the websocket pool,
-        # so this case should not happen under normal operation. However, it is
-        # still possible is the connection is closed due to any other reason.
+        # If a connection is closed due to the pool timeout before being bound
+        # to a websocket, it is not added to the wait queue in the websocket
+        # pool, so this case should not happen under normal operation. However,
+        # it is still possible if the connection is closed due to any other
+        # reason.
         @log.call "[!] bound closed before bind."
         @completion.succeed
         return @completion
@@ -97,7 +98,7 @@ module Netpump
         reason = errno.exception.message
         reason[0] = reason[0].downcase
       else
-        # win: errno can be set to :unknown on windows
+        # windows: errno can be set to :unknown
         reason = errno.to_s
       end
       @log.call "[-] unbind.", reason: reason

data/lib/netpump/server.rb

@@ -11,11 +11,10 @@ module Netpump
       @port = port
       @proxy_host = proxy_host
       @proxy_port = proxy_port
-      @log = lambda { |msg, **ctx| log(msg, rem: true, **ctx) }
+      @log = lambda { |msg, **ctx| log(msg, s: true, **ctx) }
     end
 
     def start
-      @log.call "[+] netpump server is starting.", host: @host, port: @port
       start_websocket_server
       proxy = EventMachine.start_server(
         @proxy_host, @proxy_port, EventMachine::Protocols::CONNECT
@@ -23,6 +22,7 @@ module Netpump
         fail "inactivity timeout" unless c.comm_inactivity_timeout.zero?
       end
       @proxy_port, @proxy_host = Socket.unpack_sockaddr_in(EventMachine.get_sockname(proxy))
+      @log.call "[+] np server is ready.", host: @host, port: @port
     end
 
     private
@@ -41,14 +41,14 @@ module Netpump
             bind(ws, ip)
           end
         else
-          return false
+          next false
         end
         true
       end
     end
 
     def bind(ws, ip)
-      EventMachine.connect(@proxy_host, @proxy_port, Relay, "rem") do |relay|
+      EventMachine.connect(@proxy_host, @proxy_port, Relay, "s") do |relay|
         fail "inactivity timeout" unless relay.comm_inactivity_timeout.zero?
         relay.bind(ws, ip).callback { bind(ws, ip) }
       end

data/public/netpump.html

@@ -20,12 +20,6 @@
         text-align: center;
         color: white;
       }
-      dd {
-        margin: 0;
-      }
-      input[type="checkbox"] {
-        margin-right: 0.5em;
-      }
       header {
         margin: 1em 0;
       }
@@ -36,6 +30,12 @@
       header svg {
         width: 4em;
       }
+      dd {
+        margin: 0;
+      }
+      input[type="checkbox"] {
+        margin-right: 0.5em;
+      }
     </style>
   </head>
   <body>
@@ -63,8 +63,8 @@
         // client websocket.
         var client;
         // Connect to the server first, so that when we
-        // connect to the client the whole chain is complete.
-        var server = new WebSocket(serverAddr + "/ws/rem/relay");
+        // connect to the client, the whole chain is complete.
+        var server = new WebSocket(new URL("/ws/rem/relay", serverAddr));
         // Log server errors.
         server.onerror = function (event) {
           console.error("[!] server/error", event);

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: netpump
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.2
 platform: ruby
 authors:
 - soylent
@@ -9,6 +9,20 @@ bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
 - !ruby/object:Gem::Dependency
   name: em-websocket
   requirement: !ruby/object:Gem::Requirement
@@ -43,7 +57,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - CHANGELOG
-- VERSION
 - bin/netpump
 - lib/eventmachine/websocket/client.rb
 - lib/eventmachine/websocket/server.rb
@@ -74,5 +87,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.6.9
 specification_version: 4
-summary: Tiny websocket proxy tunnel
+summary: tiny websocket proxy tunnel
 test_files: []

data/VERSION

@@ -1 +0,0 @@
-1.0.0