purr 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 00f5cd3df556c392a0350b07a3f301621cbb85e5
-  data.tar.gz: 46c2526afaf17d40188a57c6becf4eb44779dc31
+SHA256:
+  metadata.gz: e3a99873499dacf72389b46731532a26976bebeb3deae0f3bd0c244648f9993f
+  data.tar.gz: e0e21c759cd247edaf3fea274fb5c060ea144e8844587abe20be81bba3e00a38
 SHA512:
-  metadata.gz: 356fbf9104ea61edcda8f7333e35f445b8be80c55db506091707065e2ba52ddc5958294dd40e083a82397d9079e5e83d62b435759f0c887add575c8e3a0a4781
-  data.tar.gz: 371811743c189dcdffe3d3e42cc72d544f80077226ecd81309db4d6f8a0802edc0072a1e1d33fd72a14bfa9c95694b87fb19cbe03419584ee765208a34bcbc0b
+  metadata.gz: 9026cd13d3a65e47a3b9d9702e8142cd196b96ef896026f9bcf4452ad66b5d8912026bee050f46a70d58e65eca827ec5117af83b0f182db7740d40613b8589f0
+  data.tar.gz: c6d439bba854c136237198a1a2b455d0ec516d653658fd5198d2c5d663840c77691a67a3aa9927649f2e528906da216f563eb8f4f2ad12da91ef0b2252a71ba5

data/.rspec

@@ -1,2 +1,2 @@
---format documentation
+--format progress
 --color

data/README.md

@@ -1,27 +1,9 @@
-# Purr
+# Purr Server
 
-[![Build Status](https://travis-ci.org/skateman/purr.svg?branch=master)](https://travis-ci.org/skateman/purr)
-[![Dependency Status](https://gemnasium.com/skateman/purr.svg)](https://gemnasium.com/skateman/purr)
-[![Inline docs](http://inch-ci.org/github/skateman/purr.svg?branch=master)](http://inch-ci.org/github/skateman/purr)
-[![Code Climate](https://codeclimate.com/github/skateman/purr/badges/gpa.svg)](https://codeclimate.com/github/skateman/purr)
-[![codecov](https://codecov.io/gh/skateman/purr/branch/master/graph/badge.svg)](https://codecov.io/gh/skateman/purr)
-
-Purr is a TCP-over-HTTP solution which consists:
-- a Rack-based web server implemented in Ruby
-- a browser extension implemented in ES6 using Chrome App JavaScript API
-
-Using Purr it's possible to "smuggle" any kind of TCP traffic (SSH, VNC, etc.) through an HTTP connection.
-
-**Note: this is a highly experimental implementation for demonstration purposes only!**
-
-## How it works
-
-**TODO**
+This is the server part of Purr responsible for socket hijacking and forwarding TCP traffic to the remote endpoint.
 
 ## Installation
 
-### Server
-
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -36,13 +18,8 @@ Or install it yourself as:
 
     $ gem install purr
 
-### Client
-
-Currently, the client is available as a Chrome App only and it requires manual installation. It is available under the `contrib/chrome` folder and it needs to be installed manually. Note that the Chrome Apps will be [retired](https://blog.chromium.org/2016/08/from-chrome-apps-to-web.html) on other platforms than ChromeOS and this client might get unsupported in future versions of Chrome. It is planned to implement the client using a different approach in the future.
-
 ## Usage
 
-### Server
 The server needs to be wrapped as a Rack application and it's necessary to pass a block that takes one argument. This block should implement the TCP remote endpoint selection based on the **env** variable passed from the Rack context. The endpoint should be in the form of a two element array containing the host as a string and the port as an integer. There is a basic logging support implemented, but it is requires the `Rack::Logger` middleware to be included.
 
 ```ruby
@@ -69,17 +46,6 @@ rackup purr.ru
 
 Note that the application requires a web server with [socket hijacking](http://www.rubydoc.info/github/rack/rack/file/SPEC#Hijacking) support, i.e. you can't use WEBrick.
 
-### Client
-The client can be invoked by pointing your browser to an URL in the form: `http://purr/<URL>`
-
-Where the `<URL>` is an URL encoded using [`encodeURIComponent`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/encodeURIComponent) pointing to the server described above.
-
-Because the client catches the URL, it will never appear in the browser's address bar. Therefore, it is not recommended to use `window.open` or `window.location.href` for invoking the client as it will create an empty window. A better solution is to use `window.location.assign` from and existing window with "useful data":
-
-```js
-window.location.assign(`http://purr/${encodeURIComponent('http://example.com/vnc?id=1234')}`)
-```
-
 ### Reverse proxy support
 
 - TODO: Describe websocket compatibility mode and how it works with Apache mod_proxy_wstunnel
@@ -87,7 +53,7 @@ window.location.assign(`http://purr/${encodeURIComponent('http://example.com/vnc
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` in the `server` subdirectory to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
@@ -95,8 +61,6 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/skateman/purr.
 
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/lib/purr/server.rb

@@ -1,3 +1,5 @@
+require "irb"
+require 'socket'
 require 'surro-gate'
 
 module Purr
@@ -15,6 +17,24 @@ module Purr
 
       @remote = block
       @proxy = SurroGate.new
+
+      @transmitter = Thread.new do
+        loop do
+          @proxy.select(1000)
+
+          @proxy.each_ready do |left, right|
+            begin
+              right.write_nonblock(left.read_nonblock(4096))
+            rescue => ex
+              # FIXME: env is not available here, logging is probably bad in this way
+              # logger(env, :info, "Connection #{left} <-> #{right} closed due to #{ex}")
+              cleanup(left, right)
+            end
+          end
+        end
+      end
+
+      @transmitter.abort_on_exception = true
     end
 
     # Method required by the Rack API
@@ -47,11 +67,8 @@ module Purr
       return [200, {}, []]
     rescue => ex
       logger(env, :error, "#{ex.class} happened for #{env['REMOTE_ADDR']} trying to access #{host}:#{port}")
-      # Clean up the opened sockets if available
-      http.close unless http.nil? || http.closed?
-      sock.close unless sock.nil? || sock.closed?
-      # Return with a 404 error
-      return not_found
+      cleanup(http, sock)
+      return not_found # Return with a 404 error
     end
 
     private
@@ -74,8 +91,8 @@ module Purr
       <<~HEREDOC.sub(/\n$/, "\n\n").gsub(/ {2,}/, '').gsub("\n", "\r\n")
       HTTP/1.1 101 Switching Protocols
       Upgrade: #{upgrade}
-      PURR_VERSION: #{Purr::VERSION}
-      PURR_REQUEST: MEOW
+      Purr-Version: #{Purr::VERSION}
+      Purr-Request: MEOW
       Connection: Upgrade
       HEREDOC
     end
@@ -84,6 +101,14 @@ module Purr
       [404, { 'Content-Type' => 'text/plain' }, ['Not found!']]
     end
 
+    def cleanup(*sockets)
+      # Omit `nil`s from the array
+      sockets.compact!
+      # Close the opened sockets and remove them from the proxy
+      sockets.each { |sock| sock.close unless sock.closed? }
+      @proxy.pop(*sockets)
+    end
+
     def logger(env, level, message)
       # Do logging only if Rack::Logger is loaded as a middleware
       env['rack.logger'].send(level, message) if env['rack.logger']

data/lib/purr/version.rb

@@ -1,4 +1,4 @@
 module Purr
-  VERSION = '0.1.0'.freeze
-  SUPPORT = %w(0.1.0).freeze
+  VERSION = '0.1.1'.freeze
+  SUPPORT = %w(0.1.0 0.1.1).freeze
 end

data/purr.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'rack', '~> 2.0.0'
-  spec.add_dependency 'surro-gate', '~> 0.1.1'
+  spec.add_dependency 'surro-gate', '~> 1.0.4'
 
   spec.add_development_dependency 'bundler', '~> 1.13'
   spec.add_development_dependency 'codecov', '~> 0.1.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: purr
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Dávid Halász
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-24 00:00:00.000000000 Z
+date: 2019-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: 1.0.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: 1.0.4
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -118,21 +118,12 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
-- contrib/chrome/_locales/en/messages.json
-- contrib/chrome/images/icon-128.png
-- contrib/chrome/images/icon-16.png
-- contrib/chrome/index.html
-- contrib/chrome/manifest.json
-- contrib/chrome/scripts/background.js
-- contrib/chrome/scripts/main.js
-- contrib/chrome/styles/main.css
 - lib/purr.rb
 - lib/purr/server.rb
 - lib/purr/version.rb
@@ -156,8 +147,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: Smuggle TCP connections through HTTP

data/.travis.yml

@@ -1,8 +0,0 @@
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.3.1
-before_install:
-  - "echo 'gem: --no-ri --no-rdoc --no-document' > ~/.gemrc"
-  - "gem install bundler -v 1.13.0"

data/contrib/chrome/_locales/en/messages.json

@@ -1 +0,0 @@
-{}

data/contrib/chrome/index.html

@@ -1,34 +0,0 @@
-<!doctype html>
-<html>
-  <head>
-    <meta charset="utf-8">
-    <title>Purr Client</title>
-    <link rel="stylesheet" type="text/css" href="styles/main.css"/>
-  </head>
-  <body>
-    <div class="container">
-      <h1>Purr Client v<span class="version"></span></h1>
-      <div class="info-messages">
-        <p class="init">
-          Initializing connection, please wait...
-        </p>
-        <p class="work hidden">
-          Listening on: <strong class="address" title="Click to copy!"></strong><br/>
-          Connected clients: <span class="clients">0</span>
-        </p>
-        <p class="error hidden">
-          <strong>Error:</strong> <span class="errmsg"></span>
-        </p>
-      </div>
-      <div class="settings">
-        <label>Compatibility:</label>
-        <select id="websocket">
-          <option value="purr">None</option>
-          <option value="websocket">Fake WebSocket</option>
-          <!-- <option value="">Full WebSocket</option> -->
-        </select>
-      </div>
-    </div>
-    <script src="scripts/main.js"></script>
-  </body>
-</html>

data/contrib/chrome/manifest.json

@@ -1,35 +0,0 @@
-{
-  "name": "Purr Client",
-  "description": "Smuggle TCP connections through HTTP",
-  "default_locale": "en",
-  "version": "0.1.0",
-  "manifest_version": 2,
-  "sockets": {
-    "tcp": {
-      "connect": "*"
-    },
-    "tcpServer": {
-      "listen": "*"
-    }
-  },
-  "url_handlers": {
-    "launch_proxy": {
-      "matches": [
-        "http://purr/*",
-        "https://purr/*"
-      ],
-      "title": "Launch Purr Client"
-    }
-  },
-  "icons": {
-    "16": "images/icon-16.png",
-    "128": "images/icon-128.png"
-  },
-  "app": {
-    "background": {
-      "scripts": [
-        "scripts/background.js"
-      ]
-    }
-  }
-}

data/contrib/chrome/scripts/background.js

@@ -1,26 +0,0 @@
-'use strict';
-
-chrome.app.runtime.onLaunched.addListener((data) => {
-  // Pass the url for further processing
-  window.url = data.url;
-  // Create the application window
-  chrome.app.window.create('index.html', {
-    innerBounds: {
-      width: 400,
-      height: 160
-    }
-  }, (win) =>
-    // Clean up all sockets if the app window gets closed
-    win.onClosed.addListener(() =>
-      ['tcp', 'tcpServer'].forEach((provider) =>
-        chrome.sockets[provider].getSockets((sockets) =>
-          sockets.forEach((socket) => {
-            chrome.sockets[provider].disconnect(socket.socketId);
-            chrome.sockets[provider].close(socket.socketId);
-          })
-        )
-      )
-    )
-  );
-});
-

data/contrib/chrome/scripts/main.js

@@ -1,178 +0,0 @@
-'use strict';
-
-const showError = (msg) => {
-  document.querySelector('.error > .errmsg').textContent = msg;
-  showInfo('error');
-};
-
-const showInfo = (klass) => {
-  if (['init', 'work', 'error'].includes(klass)) {
-    document.querySelector(`.info-messages > :not(.hidden)`).classList.add('hidden');
-    document.querySelector(`.info-messages .${klass}`).classList.remove('hidden');
-  }
-};
-
-const copyToClipboard = (e) => {
-  var input = document.createElement('textarea');
-  document.body.appendChild(input);
-  input.value = e.target.textContent;
-  input.focus();
-  input.select();
-  document.execCommand('Copy');
-  input.remove();
-};
-
-const sendHttpRequest = (sock) => {
-  // Build up the HTTP request headers
-  const upgrade = document.querySelector('#websocket').value;
-
-  const req = `
-    GET ${window.request.path} HTTP/1.1                  \r
-    Host: ${window.request.host}                         \r
-    Upgrade: ${upgrade}                                  \r
-    Purr-Request: MEOW                                   \r
-    Purr-Version: ${chrome.runtime.getManifest().version}\r
-    Connection: Upgrade                                  \r
-    User-Agent: ${navigator.userAgent}                   \r
-  `.replace(/( {2,})|(^\n)/g, '').replace(/\r\n$/, '\r\n\r\n');
-
-  let buffer = new ArrayBuffer(req.length);
-  let writer = new Uint8Array(buffer);
-  // Convert it to the appropriate format
-  for (let i=0, len=req.length; i<len; i++) {
-    writer[i] = req.charCodeAt(i);
-  }
-
-  // Send it out
-  chrome.sockets.tcp.send(sock, buffer, () => null);
-};
-
-const windowLoaded = () => new Promise((resolve, reject) =>
-  document.addEventListener('DOMContentLoaded', () => {
-    document.querySelector('span.version').textContent = chrome.runtime.getManifest().version;
-    resolve();
-  })
-);
-
-const parseBackgroundURL = () => new Promise((resolve, reject) =>
-  chrome.runtime.getBackgroundPage((background) => {
-    if (background.url) {
-      var url = new URL(decodeURIComponent(background.url.replace(/^https?:\/\/purr\// ,'')));
-      var m = url.protocol.match(/^http(s?):$/);
-
-      if (m) {
-        window.request = {
-          hostname: url.hostname,
-          host: url.host,
-          port: url.port ? parseInt(url.port) : (m[1] ? 443 : 80),
-          path: url.pathname,
-          secure: !!m[1]
-        };
-        resolve();
-      } else {
-        reject('Invalid URL!');
-      }
-    } else {
-      reject('This application cannot be started separately!');
-    }
-  })
-);
-
-const createServer = () => new Promise((resolve, reject) =>
-  chrome.sockets.tcpServer.create({}, (server) =>
-    chrome.sockets.tcpServer.listen(server.socketId, '127.0.0.1', 8888, 0, (result) =>
-      chrome.sockets.tcpServer.getInfo(server.socketId, (info) => {
-        if (result < 0) {
-          reject(`tcpServer.listen returned with ${result}`);
-        } else {
-          document.querySelector('.address').textContent = `127.0.0.1:${info.localPort}`;
-          document.querySelector('.address').onclick = copyToClipboard;
-          showInfo('work');
-          resolve(server.socketId);
-        }
-      })
-    )
-  )
-);
-
-const setListeners = (promise) => {
-  // Set up the proxying
-  chrome.sockets.tcp.onReceive.addListener((recv) => {
-    let node = window.pairing[recv.socketId];
-    if (node.purr) { // Synchronize
-      // Convert the response to a readable format
-      let response = String.fromCharCode.apply(null, new Uint8Array(recv.data));
-
-      if (response.match(/^HTTP\/1\.1 101 Switching Protocols/)) {
-        // If the upgrade was successful, unpause the socket
-        chrome.sockets.tcp.setPaused(node.pair, false, () =>
-          delete node.purr
-        );
-      } else {
-        // The upgrade was not successful, close the connection
-        console.error('Error happened during HTTP upgrade...')
-        cleanupClient(recv.socketId);
-      }
-
-    } else { // Transmit normally
-      chrome.sockets.tcp.send(node.pair, recv.data, () => null);
-    }
-  });
-
-  // Error handling for client connections
-  chrome.sockets.tcp.onReceiveError.addListener((err) =>
-    cleanupClient(err.socketId)
-  );
-
- // Keeping up the promise-chain
-  return promise;
-};
-
-const createClient = (peer) => new Promise((resolve, reject) =>
-  chrome.sockets.tcp.create({}, (client) =>
-    chrome.sockets.tcp.connect(client.socketId, window.request.hostname, window.request.port, (result) => {
-      if (result < 0) {
-        reject(`tcp.connect returned with ${result}`);
-      } else {
-        // Set up socket pairing information
-        window.pairing[peer] = { pair: client.socketId };
-        window.pairing[client.socketId] = { pair: peer, purr: true };
-        updateClients();
-        resolve(client.socketId);
-      }
-    })
-  )
-);
-
-const cleanupClient = (sock) => {
-  let node = window.pairing[sock];
-  if (node) { // Do not close them twice
-    delete window.pairing[sock];
-    delete window.pairing[node.pair];
-
-    updateClients();
-
-    chrome.sockets.tcp.close(sock);
-    chrome.sockets.tcp.close(node.pair);
-  }
-};
-
-const acceptServer = (server) => {
-  chrome.sockets.tcpServer.onAccept.addListener((client) => {
-    createClient(client.clientSocketId).then(sendHttpRequest, showError);
-    return server;
-  })
-};
-
-const updateClients = () => {
-  document.querySelector('.clients').textContent = parseInt(Object.keys(pairing).length / 2);
-};
-
-window.pairing = {};
-
-windowLoaded()
-.then(parseBackgroundURL)
-.then(createServer)
-.then(setListeners)
-.then(acceptServer)
-.catch(showError);

data/contrib/chrome/styles/main.css

@@ -1,20 +0,0 @@
-strong.address:hover {
-  cursor: pointer;
-  text-decoration: underline;
-}
-
-.error {
-  color: red;
-}
-
-.hidden {
-  display: none;
-}
-
-.container {
-  text-align: center;
-}
-
-.info-messages {
-  font-size: larger;
-}