proxyprotocol 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 01ac713c25f1bebcb9c0587123404d74e1f7bfbc
+  data.tar.gz: 7b12f6133e9837b80489dcf494fe8a1f1edab73e
+SHA512:
+  metadata.gz: 394d402fee3b672047a50061bcf90c4c2e74b9fe0305d36a56da27fda320d126ee150ee8ca3192fc11685d4e58247d2957c2bbf1f137a0aa02bba1681c13702f
+  data.tar.gz: 8a6a6d886a196eafc355ec568f68d1b7973ab5794c6835ed405f0465dc0b636f679a94dee82805ace25eb6d68a4233b21a8a4046825590424b685cd4024c1f28

data/.gitignore

@@ -0,0 +1,19 @@
+*.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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in proxyprotocol.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,29 @@
+Copyright (c) 2014, Heroku Inc.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+* Redistributions of source code must retain the above copyright
+  notice, this list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright
+  notice, this list of conditions and the following disclaimer in the
+  documentation and/or other materials provided with the distribution.
+
+* The names of its contributors may not be used to endorse or promote
+  products derived from this software without specific prior written
+  permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,42 @@
+# Proxyprotocol
+
+A `Proxyprotocol::TCPSocket` that inherits `TCPSocket` to provide the
+[proxy protocol](http://haproxy.1wt.eu/download/1.5/doc/proxy-protocol.txt)
+header on connect.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'proxyprotocol'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install proxyprotocol
+
+## Usage
+
+Use it like `TCPSocket`.
+
+``` ruby
+socket = ProxyProtocol::TCPSocket.new(RemoteHost, RemotePort, SourceIp,
+                                      SourcePort, DestIp, DestPort)
+```
+
+## Run the tests
+
+``` bash
+$ bundle exec rspec
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/omarkj/proxyprotocol/fork )
+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

data/Rakefile

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

data/lib/proxyprotocol.rb

@@ -0,0 +1,6 @@
+require "proxyprotocol/version"
+require "proxyprotocol/tcpsocket"
+require "proxyprotocol/socket"
+
+module ProxyProtocol
+end

data/lib/proxyprotocol/header.rb

@@ -0,0 +1,24 @@
+require "ipaddr"
+
+module ProxyProtocol
+  module Header
+    def proxy_protocol_header(source_ip, source_port, dest_ip, dest_port)
+      if [source_ip, source_port, dest_ip, dest_port].include?(nil)
+        "PROXY UNKNOWN\r\n"
+      else
+        source_ip = IPAddr.new(source_ip) unless source_ip.kind_of?(IPAddr)
+        dest_ip = IPAddr.new(dest_ip) unless dest_ip.kind_of?(IPAddr)
+        version = ip_version(source_ip, dest_ip)
+        "PROXY #{version} #{source_ip.to_s} #{dest_ip.to_s} #{source_port} #{dest_port}\r\n"
+      end
+    end
+    
+    def ip_version(source_ip, dest_ip)
+      if source_ip.ipv4? and dest_ip.ipv4?
+        "TCP4"
+      elsif source_ip.ipv6? and dest_ip.ipv6?
+        "TCP6"
+      end
+    end
+  end
+end

data/lib/proxyprotocol/socket.rb

@@ -0,0 +1,18 @@
+require "socket"
+
+module ProxyProtocol
+  class Socket < Socket
+    include Header
+    def initialize(domain, socktype, protocol=0, source_ip=nil, source_port=nil,
+                   dest_ip=nil, dest_port=nil, local_host=nil, local_port=nil)
+      @header = proxy_protocol_header(source_ip, source_port, dest_ip,
+                                      dest_port)
+      super(domain, socktype, protocol=0)
+    end
+
+    def connect(remote_sockaddr)
+      super
+      write(@header)
+    end
+  end
+end

data/lib/proxyprotocol/tcpsocket.rb

@@ -0,0 +1,14 @@
+require "proxyprotocol/header"
+
+module ProxyProtocol
+  class TCPSocket < TCPSocket
+    include Header
+    def initialize(remote_host, remote_port, source_ip=nil, source_port=nil, 
+                   dest_ip=nil, dest_port=nil, local_host=nil, local_port=nil)
+      super(remote_host, remote_port, local_host, local_port)
+      header = proxy_protocol_header(source_ip, source_port, dest_ip,
+                                     dest_port)
+      write(header)
+    end
+  end
+end

data/lib/proxyprotocol/version.rb

@@ -0,0 +1,3 @@
+module ProxyProtocol
+  VERSION = "0.0.2"
+end

data/proxyprotocol.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'proxyprotocol/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "proxyprotocol"
+  spec.version       = ProxyProtocol::VERSION
+  spec.authors       = ["Ómar Kjartan Yasin"]
+  spec.email         = ["omarkj@heroku.com"]
+  spec.summary       = "A wrapper around TCPSocket that support the Proxy Protocol"
+  spec.homepage      = "https://github.com/omarkj/proxyprotocol"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/spec/proxyprotocol_spec.rb

@@ -0,0 +1,68 @@
+require 'proxyprotocol'
+require 'socket'
+
+describe "ProxyProtocol::TCPSocket" do
+  it "should send the proxy protocol header via TCPSocket" do
+    server_socket = TCPServer.new("127.0.0.1", 0)
+    result = nil
+    thread = Thread.new do
+      client = server_socket.accept
+      result = client.gets
+      client.close
+    end
+    server_port = server_socket.addr[1]
+    socket = ProxyProtocol::TCPSocket.new("127.0.0.1", server_port,
+                                          "10.0.0.1", 1000,
+                                          "192.168.1.1", 80)
+    thread.join
+    expect(result).to eq("PROXY TCP4 10.0.0.1 192.168.1.1 1000 80\r\n")
+  end
+
+  it "should send unknown protocol header via TCPSocket" do
+    server_socket = TCPServer.new("127.0.0.1", 0)
+    result = nil
+    thread = Thread.new do
+      client = server_socket.accept
+      result = client.gets
+      client.close
+    end
+    server_port = server_socket.addr[1]
+    socket = ProxyProtocol::TCPSocket.new("127.0.0.1", server_port)
+    thread.join
+    expect(result).to eq("PROXY UNKNOWN\r\n")
+  end
+
+  it "should send the proxy protocol header via Socket" do
+    server_socket = TCPServer.new("127.0.0.1", 0)
+    result = nil
+    thread = Thread.new do
+      client = server_socket.accept
+      result = client.gets
+      client.close
+    end
+    server_port = server_socket.addr[1]
+    socket = ProxyProtocol::Socket.new(Socket::AF_INET, Socket::SOCK_STREAM, 0, 
+                                       "10.0.0.1", 1000, "192.168.1.1", 80)
+    sockaddr = ProxyProtocol::Socket.pack_sockaddr_in(server_port, "127.0.0.1")
+    socket.connect(sockaddr)
+    thread.join
+    expect(result).to eq("PROXY TCP4 10.0.0.1 192.168.1.1 1000 80\r\n")
+  end
+
+  it "should send the proxy protocol header via Socket" do
+    server_socket = TCPServer.new("127.0.0.1", 0)
+    result = nil
+    thread = Thread.new do
+      client = server_socket.accept
+      result = client.gets
+      client.close
+    end
+    server_port = server_socket.addr[1]
+    socket = ProxyProtocol::Socket.new(Socket::AF_INET, Socket::SOCK_STREAM, 0)
+    sockaddr = ProxyProtocol::Socket.pack_sockaddr_in(server_port, "127.0.0.1")
+    socket.connect(sockaddr)
+    thread.join
+    expect(result).to eq("PROXY UNKNOWN\r\n")
+  end
+
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: proxyprotocol
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Ómar Kjartan Yasin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- omarkj@heroku.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/proxyprotocol.rb
+- lib/proxyprotocol/header.rb
+- lib/proxyprotocol/socket.rb
+- lib/proxyprotocol/tcpsocket.rb
+- lib/proxyprotocol/version.rb
+- proxyprotocol.gemspec
+- spec/proxyprotocol_spec.rb
+homepage: https://github.com/omarkj/proxyprotocol
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.0
+signing_key: 
+specification_version: 4
+summary: A wrapper around TCPSocket that support the Proxy Protocol
+test_files:
+- spec/proxyprotocol_spec.rb