rendezvous-socket 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+ruby "1.9.3"
+
+# Specify your gem's dependencies in rendezvous-socket.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Michael Hale
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,59 @@
+# Rendezvous::Socket
+
+Using the help of a well known rendezvous endpoint establish a peer to
+peer connection between clients which may be behind NAT firewalls. In
+the event that NAT traversal techniques are not successful fallback to
+relaying the connection through the rendezvous server. All connections
+are SSL encrypted. Sessions are managed by the server.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rendezvous-socket'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rendezvous-socket
+
+## Usage
+
+1. On a server with a known IP address run the server.
+
+  ```bash
+  rendezvous-server
+  ```
+2. On 2 peer machines that wish to establish a direct connection with each other run the client.
+
+  ```bash
+  RENDEZVOUS_SERVER=n.n.n.n:5000 rendezvous-client
+  ```
+
+You will know it worked when you see the hostname of each peer in the
+output of it's peer.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## TODO
+
+* Speed. Can a connection be established in < 4 seconds?
+* Server managed sessions
+* SSL
+* Clean interface (as similar to socket interface as possible)
+* Fallback to relay mode
+
+## Inspiration
+
+* http://www.brynosaurus.com/pub/net/p2pnat/
+* https://github.com/dceballos/tcpnatr
+* http://stackoverflow.com/a/14388707

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/rendezvous-client

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rendezvous/socket'
+
+$DEBUG = true if ENV['DEBUG']
+
+s = Rendezvous::Socket.new(ENV['RENDEZVOUS_SERVER']).open
+s.close
+s.puts Socket.gethostname
+puts s.gets
+
+i = 0
+while true
+  s.puts i = i + 1
+  puts s.gets
+  sleep 1
+end

data/bin/rendezvous-server

@@ -0,0 +1,42 @@
+#!/usr/bin/env ruby
+
+require 'socket'
+require 'thread'
+semaphore = Mutex.new
+
+PEERS = []
+
+def peer(c)
+  [c.peeraddr[3], c.peeraddr[1]].join(":")
+end
+
+def handle_client(client)
+  puts peer(client)
+
+  #semaphore.synchronize do
+    PEERS << client
+    
+    case PEERS.size
+    when 0,1
+      #noop
+    when 2
+      peer_a = PEERS[0]
+      peer_b = PEERS[1]
+      peer_a.puts peer(peer_b)
+      peer_b.puts peer(peer_a)
+      peer_a.close
+      peer_b.close
+      PEERS.clear
+    else
+      PEERS.clear
+    end
+  #end
+end
+
+s = TCPServer.new('0.0.0.0', 5000)
+loop do
+  Thread.start(s.accept) do |client|
+    handle_client(client)
+  end
+end
+s.close

data/lib/rendezvous/socket.rb

@@ -0,0 +1,55 @@
+require "rendezvous/socket/version"
+require "rendezvous/socket/custom_socket"
+
+module Rendezvous
+  module Socket
+
+    def self.new(server)
+      RendezvousSocket.new(server)
+    end
+
+    class RendezvousSocket
+      attr_reader :rendezvous_server
+
+      def initialize(rendezvous_server)
+        @rendezvous_server = rendezvous_server
+        super()
+      end
+
+      def log(args={})
+        start = Time.now
+        puts args.merge(at: :start)
+        result = yield
+        elapsed = Time.now - start
+        puts args.merge(at: :finish, elapsed: elapsed)
+        result
+      end
+
+      # lport=0 causes OS to select a random high port
+      def get_peer_endpoint(lport=0)
+        socket = CustomSocket.new
+        socket.bind(lport)
+        socket.connect(*rendezvous_server.split(":"))
+
+        rhost, rport = socket.gets.chomp.split(":")
+        [socket.local_port, rhost, rport.to_i]
+      end
+
+      def peer_socket(lport, rhost, rport)
+        peer = CustomSocket.new
+        peer.bind(lport)
+        peer if peer.connect(rhost, rport)
+      end
+
+      def open
+        lport, rhost, rport = nil
+        log(step: :get_peer_endpoint) {
+          lport, rhost, rport = get_peer_endpoint
+        }
+        log(step: :connect) {
+          peer_socket(lport, rhost, rport)
+        }
+      end
+    end
+  end
+end

data/lib/rendezvous/socket/custom_socket.rb

@@ -0,0 +1,45 @@
+require 'socket'
+
+module Rendezvous
+  module Socket
+    class CustomSocket < ::Socket
+      def initialize
+        super(AF_INET, SOCK_STREAM, 0)
+        setsockopt(SOL_SOCKET, SO_REUSEADDR, 1)
+        if defined?(SO_REUSEPORT)
+          setsockopt(SOL_SOCKET, SO_REUSEPORT, 1)
+        end
+      end
+
+      def listen(buf)
+        $stderr.puts "attempting to listen" if $DEBUG
+        super(buf)
+      end
+
+      def bind(port = 0)
+        ip = ::Socket.ip_address_list.detect{|a| a.ipv4_private? }.ip_address
+        $stderr.puts "attempting to bind to #{ip}:#{port}" if $DEBUG
+        addr_local = ::Socket.pack_sockaddr_in(port, ip)
+        super(addr_local)
+      end
+
+      def connect(ip, port)
+        $stderr.puts "attempting to connect to #{ip}:#{port}" if $DEBUG
+        addr_remote = ::Socket.pack_sockaddr_in(port, ip)
+        super(addr_remote)
+      end
+
+      def accept
+        super[0]
+      end
+
+      def addr
+        ::Socket.unpack_sockaddr_in(getsockname)
+      end
+
+      def local_port
+        addr[0]
+      end
+    end
+  end
+end

data/lib/rendezvous/socket/version.rb

@@ -0,0 +1,5 @@
+module Rendezvous
+  module Socket
+    VERSION = "0.0.1"
+  end
+end

data/rendezvous-socket.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rendezvous/socket/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rendezvous-socket"
+  spec.version       = Rendezvous::Socket::VERSION
+  spec.authors       = ["Michael Hale"]
+  spec.email         = ["mike@hales.ws"]
+  spec.description   = File.read('README.md').match(/\A#\s+[^\n]+\n+([\W\w]+?)\n+##/)[1].chomp # http://rubular.com/r/vzsBvug0GC
+  spec.summary       = %q{A ruby socket object which attempts to establish a P2P connection}
+  spec.homepage      = "https://github.com/mikehale/rendezvous-socket/"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: rendezvous-socket
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Michael Hale
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! 'Using the help of a well known rendezvous endpoint establish a peer
+  to
+
+  peer connection between clients which may be behind NAT firewalls. In
+
+  the event that NAT traversal techniques are not successful fallback to
+
+  relaying the connection through the rendezvous server. All connections
+
+  are SSL encrypted. Sessions are managed by the server.'
+email:
+- mike@hales.ws
+executables:
+- rendezvous-client
+- rendezvous-server
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/rendezvous-client
+- bin/rendezvous-server
+- lib/rendezvous/socket.rb
+- lib/rendezvous/socket/custom_socket.rb
+- lib/rendezvous/socket/version.rb
+- rendezvous-socket.gemspec
+homepage: https://github.com/mikehale/rendezvous-socket/
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A ruby socket object which attempts to establish a P2P connection
+test_files: []