weblink 1.0.0 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c268c95b2cdcec3669dbf5c90f0753bc28949b6098744bd7c9f9e42aac24bb97
-  data.tar.gz: 44f0363bf19eae1f40a5a00fd962f60134a1db2a12e36aeda7bba04fe5090855
+  metadata.gz: 13496b146b017e1d415d1fb4ee27b36deb894f158882dc376490be51a6920184
+  data.tar.gz: cf4643c4a79bb42f8f2b79e05197915e866d90d54be68689aa3df628f237385e
 SHA512:
-  metadata.gz: 72ba709dd3bbdc06582bb20a83ab50090d8a60859698f4a00576122b0cd9687ed348b24d4ddbadc99219011750b897e4596605369c46e75655a821c7a76c4716
-  data.tar.gz: d729d225e330f6ab9714bd078893eeeecccb5d56e85f0f5d39c92f4b192a4fd9f94243789b94e0008b6264906d6a33c50f59682cb5afb215b0f21aa649202515
+  metadata.gz: 11b4b83e40f513ef9b4cbeb3ae532dc5c794da491e0adc06b69fa9c3736c80148998d26c1cf0eef78ff1cced9bfea691806bfebf7fb1bbd6ec720f453936d695
+  data.tar.gz: d2083018ee29d25126c5379524bd59af249e55ac8b3b5030517b7ba905a2d122a5851a9fcb43611b215799acaeefbed3a88e4163946ef68c8426b01d2ff9ed8b

data/CHANGELOG

@@ -1,3 +1,17 @@
+1.1.2
+
+* Add webrick as a runtime dependency
+
+1.1.1
+
+* Ignore interfaces with nil addresses
+
+1.1.0
+
+* Works on Windows
+* HTTPS proxy support
+
 1.0.0
 
 * First public release
+* SOCKS5 proxy support

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.1.2

data/bin/weblink

@@ -1,5 +1,4 @@
 #!/usr/bin/env -S ruby -w
-# frozen_string_literal: true
 
 $LOAD_PATH.unshift File.expand_path('../lib', __dir__)
 
@@ -35,11 +34,16 @@ op = OptionParser.new do |op|
     opts[:port] = port
   end
 
+  op.on('--proxy-type TYPE', String, 'https or socks5 (default: https)') do |type|
+    raise OptionParser::InvalidArgument, type unless type == 'https' || type == 'socks5'
+    opts[:proxy_type] = type
+  end
+
   op.on('--proxy-host HOST', String, 'Address to bind proxy to(default: 0.0.0.0)') do |host|
     opts[:proxy_host] = host
   end
 
-  op.on('--proxy-port PORT', Integer, 'Use proxy PORT (default: 1080)') do |port|
+  op.on('--proxy-port PORT', Integer, 'Use proxy PORT (default: 3128)') do |port|
     opts[:proxy_port] = port
   end
 
@@ -66,8 +70,9 @@ else
   end
   opts[:host] ||= '0.0.0.0'
   opts[:port] ||= 8000
+  opts[:proxy_type] ||= 'https'
   opts[:proxy_host] ||= '0.0.0.0'
-  opts[:proxy_port] ||= 1080
+  opts[:proxy_port] ||= 3128
 end
 
 weblink = Weblink.new(opts)

data/lib/relay.rb

@@ -3,6 +3,7 @@ require 'time'
 
 class Relay < EventMachine::Connection
   def initialize(tag, xff = nil)
+    super
     pause
     @tag = tag
     @xff = xff
@@ -31,6 +32,7 @@ class Relay < EventMachine::Connection
 
   def unbind
     log('close')
+    # Status code 1000 indicates indicates a normal closure.
     @websocket&.close(1000) if @websocket&.state == :connected
   end
 

data/lib/weblink.rb

@@ -7,7 +7,8 @@ require 'relay'
 class Weblink
   def initialize(opts)
     @opts = opts
-    @proxxxy_socket = Tempfile.new('weblink')
+    @https = Tempfile.new('weblink')
+    @socks5 = Tempfile.new('weblink')
     @websockets = EventMachine::Queue.new
   end
 
@@ -15,16 +16,22 @@ class Weblink
     trap(:EXIT) { Process.waitall }
 
     if @opts[:client]
-      public = File.expand_path('../public', __dir__)
-      spawn('ruby', '-run', '-ehttpd', '--', public, err: '/dev/null')
-
-      ip = Socket.getifaddrs.find { |ifa| ifa.addr.ipv4_private? }
-      puts "Open http://#{ip.addr.ip_address}:8080/ on your other device." if ip
+      ip = Socket.getifaddrs.find { |ifa| ifa.addr&.ipv4_private? }
+      if ip
+        public = File.expand_path('../public', __dir__)
+        spawn('ruby', '-run', '-ehttpd', '--', public, err: IO::NULL)
+        puts "Open http://#{ip.addr.ip_address}:8080/ on your other device."
+      else
+        abort(
+          "Could not find an interface to listen on. " \
+          "Make sure that you are connected to your device."
+        )
+      end
     end
 
     if @opts[:server]
       begin
-        spawn('proxxxy', "socks5://#{@proxxxy_socket.path}")
+        spawn('proxxxy', "https://#{@https.path}", "socks5://#{@socks5.path}")
       rescue Errno::ENOENT
         abort('Please install proxxxy v2 to run weblink server')
       end
@@ -38,8 +45,10 @@ class Weblink
           puts 'Ready'
         when '/client'
           @websockets.push(ws)
-        when '/server'
-          proxy(ws, handshake)
+        when '/proxy/socks5'
+          proxy(ws, handshake, @socks5.path)
+        when '/proxy/https'
+          proxy(ws, handshake, @https.path)
         else
           warn("Unexpected request: #{handshake.path.inspect}")
         end
@@ -53,26 +62,26 @@ class Weblink
     host, port = @opts.values_at(:proxy_host, :proxy_port)
     sig = EventMachine.start_server(host, port, Relay, 'client') do |rel|
       # Dogpile effect
-      control_ws.send_text('more_ws') if @websockets.size < min_ws_num
+      control_ws.send_text(@opts[:proxy_type]) if @websockets.size < min_ws_num
       @websockets.pop { |ws| rel.start(ws) }
     end
     control_ws.onclose { EventMachine.stop_server(sig) }
   end
 
-  def proxy(ws, handshake)
+  def proxy(ws, handshake, socket)
     unless @opts[:server]
       warn 'weblink server is disabled'
       return
     end
     xff = handshake.headers_downcased['x-forwarded-for']
-    with_retry(3) do
-      EventMachine.connect(@proxxxy_socket.path, Relay, 'server', xff) do |rel|
+    with_retry(timeout: 3) do
+      EventMachine.connect(socket, Relay, 'server', xff) do |rel|
         rel.start(ws)
       end
     end
   end
 
-  def with_retry(timeout, wait: 0.1)
+  def with_retry(timeout:, wait: 0.1)
     elapsed = 0
     begin
       yield

data/public/index.html

@@ -1,67 +1,73 @@
+<!DOCTYPE html>
 <html>
   <head>
     <meta charset="utf-8" />
     <title>weblink</title>
     <link rel="manifest" href="/weblink.webmanifest">
     <style>
+      html, body {
+        height: 100%;
+      }
       body {
+        align-items: center;
         background-color: #3f9cff;
         color: white;
+        display: flex;
+        justify-content: center;
       }
       h1 {
-        align-items: center;
-        display: flex;
         font-family: sans-serif;
         font-size: 8em;
-        justify-content: center;
-        height: 100%;
       }
     </style>
   </head>
   <body>
     <h1>weblink</h1>
     <script>
-      function connect({ client_addr, server_addr }) {
-        const client = new WebSocket(client_addr + "/client");
-        const server = new WebSocket(server_addr + "/server");
+      function connect(client_addr, server_addr, proxy) {
+        var client, server = new WebSocket(server_addr + "/proxy/" + proxy);
 
         server.onerror = function(event) { console.error("server/error"); };
-        client.onerror =  function(event) { console.error("client/error"); };
 
-        client.onopen = function() {
-          server.onopen = function() {
+        server.onopen = function() {
+          client = new WebSocket(client_addr + "/client");
+
+          client.onerror =  function(event) { console.error("client/error"); };
+
+          client.onopen = function() {
             client.onmessage = function(msg) { server.send(msg.data); };
             server.onmessage = function(msg) { client.send(msg.data); };
           };
+
+          client.onclose = function(event) {
+            console.log("client/close", event.code, event.reason);
+            if (server.readyState === WebSocket.OPEN) server.close();
+          };
         };
 
         server.onclose = function(event) {
           console.log("server/close", event.code, event.reason);
-
           if (client.readyState === WebSocket.OPEN) client.close();
         };
-
-        client.onclose = function(event) {
-          console.log("client/close", event.code, event.reason);
-
-          if (server.readyState === WebSocket.OPEN) server.close();
-        };
       }
 
-      const url = new URL(location.href);
-      const client_addr = `ws://${location.hostname}:8000`;
-      const server_addr = url.searchParams.get("server") || "wss://weblinkapp.herokuapp.com";
-      const batch_size = Number(url.searchParams.get("batch")) || 4
-      const control = new WebSocket(client_addr + "/control");
+      var params = {};
+      window.location.href.replace(/[?&]+([^=&]+)=([^&]*)/g, function(m, key, value) {
+        params[key] = decodeURIComponent(value);
+      });
+
+      var client_addr = "ws://" + location.hostname + ":8000";
+      var server_addr = params.server || "wss://weblinkapp.herokuapp.com";
+      var batch_size = Number(params.batch) || 4;
+      var control = new WebSocket(client_addr + "/control");
 
       control.onerror = function(event) { console.error("control/error"); };
       control.onclose = function(event) { console.log("control/close"); };
       control.onmessage = function(msg) {
         for (var i = 0; i < batch_size; i++) {
-          connect({ client_addr, server_addr });
+          connect(client_addr, server_addr, msg.data);
         }
       };
-      control.onmessage();
     </script>
   </body>
 </html>

data/public/weblink.js

@@ -0,0 +1,59 @@
+function connect(client_addr, server_addr) {
+  var client = new WebSocket(client_addr + "/client");
+  var server = new WebSocket(server_addr + "/server");
+
+  server.onerror = function(event) {
+    console.error("server/error");
+  };
+  client.onerror = function(event) {
+    console.error("client/error");
+  };
+
+  client.onopen = function() {
+    server.onopen = function() {
+      client.onmessage = function(msg) {
+        server.send(msg.data);
+      };
+      server.onmessage = function(msg) {
+        client.send(msg.data);
+      };
+    };
+  };
+
+  server.onclose = function(event) {
+    console.log("server/close", event.code, event.reason);
+
+    if (client.readyState === WebSocket.OPEN) client.close();
+  };
+
+  client.onclose = function(event) {
+    console.log("client/close", event.code, event.reason);
+
+    if (server.readyState === WebSocket.OPEN) server.close();
+  };
+}
+
+var params = {};
+window.location.href.replace(/[?&]+([^=&]+)=([^&]*)/g, function(m, key, value) {
+  params[key] = value;
+});
+
+var client_addr = "ws://" + location.hostname + ":8000";
+var server_addr = params.server || "wss://weblinkapp.herokuapp.com";
+var batch_size = Number(params.batch) || 4;
+var control = new WebSocket(client_addr + "/control");
+
+control.onerror = function(event) {
+  console.error("control/error");
+};
+control.onclose = function(event) {
+  console.log("control/close");
+};
+control.onmessage = function(msg) {
+  for (var i = 0; i < batch_size; i++)
+    connect(
+      client_addr,
+      server_addr
+    );
+};
+control.onmessage();

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: weblink
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.2
 platform: ruby
 authors:
 - soylent
@@ -10,25 +10,30 @@ bindir: bin
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
-  MIIDGjCCAgKgAwIBAgIBATANBgkqhkiG9w0BAQsFADAaMRgwFgYDVQQDDA9lZmly
-  L0RDPXNveWxlbnQwHhcNMjAwMzA3MDEzNzUwWhcNMjEwMzA3MDEzNzUwWjAaMRgw
-  FgYDVQQDDA9lZmlyL0RDPXNveWxlbnQwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAw
-  ggEKAoIBAQC2DMbzgA39U+3VTMjXn+0jnOQyLdmXQ5EXgSLKCgBLIcFTc9J47Th0
-  7Yb/f4RzWh49/EkDBiDtLqFeKBYsj3q0e8tRCAs32NtVyl/4FDyJvWsK3R2tcXOV
-  qxs48J3CgG+rFLOcMC9YF4FPTkz4p3EYGFVjZTbiqyVVuIZzWtrwdZesBVgpBRyN
-  8sEyNoi8vcDiOmEwf9/TVMTDf/wu6a+i3LNVGYWlvgMJRssaAnj/IbFFtPTz30Hx
-  eTUdfJu8YbwRspfFzcJGLf32E7vXfmHHqNzqjh4zD9sVpvTHbqLLsgVa+nYHPHAe
-  dzSZ5gZjG1oZ7hZDCJoEPj0oCHT0qkuXAgMBAAGjazBpMAkGA1UdEwQCMAAwCwYD
-  VR0PBAQDAgSwMB0GA1UdDgQWBBSsvp1HAfA+QTjOg/ehyhv7adp0FjAXBgNVHREE
-  EDAOgQxlZmlyQHNveWxlbnQwFwYDVR0SBBAwDoEMZWZpckBzb3lsZW50MA0GCSqG
-  SIb3DQEBCwUAA4IBAQBsJ7htnm3RB5xQwzC2agRAgG2ax5uaD6lCEPWshGJbfT6v
-  jaRrwrPSbaxBTD2v8QpXJe/fALJKWHUbNZilZU2t7HyQkfSyVQyLYcjo7lWFoHA1
-  z0YB3dCGcMkvLa7r73ynEtYbnYfesbXVlcRJG7SgJqWvZMnj1HnYfBevlcjSBFy2
-  5xZKSwreHM+va8McxpEZmG3ecdefRQ1u+xZabamN2hhel3nKF1BUBqgxYWXYRkZP
-  VIAqJBK/gwFlRxVYjmi2w4Ouc4wL8HtX104yQqOuD9gVPN6PJecue66As7i2I/2q
-  EARmnubhy24GUdxEooHV6pOs1mLLRuFepMgBnHfs
+  MIIEDjCCAvagAwIBAgIBATANBgkqhkiG9w0BAQsFADB3MRgwFgYDVQQDDA8xNTkz
+  ODYwX3NveWxlbnQxFTATBgoJkiaJk/IsZAEZFgV1c2VyczEXMBUGCgmSJomT8ixk
+  ARkWB25vcmVwbHkxFjAUBgoJkiaJk/IsZAEZFgZnaXRodWIxEzARBgoJkiaJk/Is
+  ZAEZFgNjb20wHhcNMjIwMTI3MDIzMTQwWhcNMjMwMTI3MDIzMTQwWjB3MRgwFgYD
+  VQQDDA8xNTkzODYwX3NveWxlbnQxFTATBgoJkiaJk/IsZAEZFgV1c2VyczEXMBUG
+  CgmSJomT8ixkARkWB25vcmVwbHkxFjAUBgoJkiaJk/IsZAEZFgZnaXRodWIxEzAR
+  BgoJkiaJk/IsZAEZFgNjb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIB
+  AQC2DMbzgA39U+3VTMjXn+0jnOQyLdmXQ5EXgSLKCgBLIcFTc9J47Th07Yb/f4Rz
+  Wh49/EkDBiDtLqFeKBYsj3q0e8tRCAs32NtVyl/4FDyJvWsK3R2tcXOVqxs48J3C
+  gG+rFLOcMC9YF4FPTkz4p3EYGFVjZTbiqyVVuIZzWtrwdZesBVgpBRyN8sEyNoi8
+  vcDiOmEwf9/TVMTDf/wu6a+i3LNVGYWlvgMJRssaAnj/IbFFtPTz30HxeTUdfJu8
+  YbwRspfFzcJGLf32E7vXfmHHqNzqjh4zD9sVpvTHbqLLsgVa+nYHPHAedzSZ5gZj
+  G1oZ7hZDCJoEPj0oCHT0qkuXAgMBAAGjgaQwgaEwCQYDVR0TBAIwADALBgNVHQ8E
+  BAMCBLAwHQYDVR0OBBYEFKy+nUcB8D5BOM6D96HKG/tp2nQWMDMGA1UdEQQsMCqB
+  KDE1OTM4NjArc295bGVudEB1c2Vycy5ub3JlcGx5LmdpdGh1Yi5jb20wMwYDVR0S
+  BCwwKoEoMTU5Mzg2MCtzb3lsZW50QHVzZXJzLm5vcmVwbHkuZ2l0aHViLmNvbTAN
+  BgkqhkiG9w0BAQsFAAOCAQEAsfJgulszbe+BgUP9xNYixuvm/R8Um5T8OAANmc+s
+  CvV3lD5XtFuw838TbWrqgN+7dVkzQYERTz8DjPtx+zlgzNS3GyMWNUZdOPLo/YkR
+  S7KfmAZlZhy1rcrARYsAouvP+1QttbiJ32L+z1JzAz2s1+4ySgl1OaQfosS04QGT
+  CnJ982/OGeG5xm7KFOqSzG4KnyEy4VH47aE4IQk+yP6R96neHdfOd/C7BcA6gbgH
+  lyshHS0Bgr1OKk3Vx8GtaIa7L9Z4RN0EWBL3QGlhiu55PrpPuAFDDuORJfpIqrph
+  XjC/3xZEDxBLYSjeFIgUMN6+/XGduQANkZ6167QsVu/yPg==
   -----END CERTIFICATE-----
-date: 2020-12-23 00:00:00.000000000 Z
+date: 2022-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: em-websocket
@@ -44,6 +49,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: webrick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
 description:
 email:
 executables:
@@ -63,6 +82,7 @@ files:
 - public/favicon-32x32.png
 - public/favicon.ico
 - public/index.html
+- public/weblink.js
 - public/weblink.webmanifest
 homepage: https://github.com/soylent/weblink
 licenses: []
@@ -82,7 +102,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.3.4
 signing_key:
 specification_version: 4
 summary: Web browser gateway