natpmp 0.8

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b79a17201396b0daf760a7454fd50ca223fdd6ab
+  data.tar.gz: db52b1791207f0330e968f380afdab5238160327
+SHA512:
+  metadata.gz: d287cc858eaecd16279e928acd2a63bc74c9c1f207494ec81d8480c25a74f86bba9ba37bc362da4a64d018fce9ee14d0a4961557d2837884f28abb333a24572d
+  data.tar.gz: 7436eb03437d9a262c7a97df52d14a45dd1c0061ded6a6a9ba1566a7dee0fad5cedb107b72bf85a85606100bd9b0fa84354011f6202359160c7c835a9048dcad

data/bin/natpmp

@@ -0,0 +1,86 @@
+#!/usr/bin/env ruby
+#
+require 'natpmp'
+require 'natpmp/version'
+require 'ostruct'
+require 'optparse'
+
+# TODO Extend the mapping if the command takes longer
+# than the timeout.
+
+types = [:tcp, :udp]
+
+opts = OpenStruct.new(port: nil, type: :tcp, verbose: false, public: 0, ttl: 7200)
+
+OptionParser.new do |o|
+    o.banner = "usage: #{o.program_name} [options] [command]"
+    o.separator "Open a port on a NAT-PMP gateway. Options:"
+
+    o.on_tail( '-?', '--help', 'Display this screen' ) do
+        puts o
+        exit
+    end
+    o.on('-t', '--type TYPE', types, "Type: #{types.join(', ')} (default: #{opts.type})") do |t|
+        opts.type = t
+    end
+    o.on('-p', '--port PORT', Integer, "Private port (default: auto)") do |n|
+        opts.port = n
+    end
+    o.on('--ttl TIME', Integer, "TTL if no command (default #{opts.ttl} sec)") do |n|
+        opts.ttl = n
+    end
+    o.on('-P', '--public PUBPORT', Integer, "External port (default: auto)") do |n|
+        opts.public = n
+    end
+    o.on('-v', '--verbose', "Verbose") do
+        opts.verbose = true
+    end
+    o.on('--version', "Version") do
+        STDERR.puts "#{o.program_name}: Version #{NATPMP::VERSION}"
+        exit;
+    end
+    o.separator "In the command string the following substitutions will be made:"
+    o.separator "  %p the local port"
+    o.separator "  %h the local IP address"
+    o.separator "  %P the gateway port"
+    o.separator "  %H the gateway IP address"
+    o.separator "(Use %% to avoid this)"
+    o.separator "The mapping will be closed on completion of the command"
+    o.parse! rescue (STDERR.puts "#{o.program_name}: #{$!}\n#{o.to_s}"; exit)
+end
+
+NATPMP.verbose opts.verbose
+
+unless opts.port
+  require 'socket'
+  p = Addrinfo.send(opts.type, "0.0.0.0", 0).bind
+  opts.localhost, opts.port = p.local_address.ip_unpack
+  STDERR.puts "Local port: #{opts.port}" if opts.verbose
+end
+
+if opts.verbose
+  begin
+    STDERR.puts "Gateway: #{NATPMP.GW}"
+    STDERR.puts "External IP: #{NATPMP.addr}"
+  rescue
+    STDERR.puts "#{opts.programname}: Error #{$!}"
+  end
+end
+
+if ARGV.size > 0
+  command = ARGV.join(' ')
+  NATPMP.map opts.port, opts.public, opts.ttl, opts.type do |map|
+    command.gsub! /(?<!%)%p/, map.priv.to_s
+    command.gsub! /(?<!%)%h/, opts.localhost.to_s
+    command.gsub! /(?<!%)%P/, map.mapped.to_s
+    command.gsub! /(?<!%)%H/, NATPMP.addr
+    command.gsub! /%%([hpHP])/,'%\\1' 
+    STDERR.puts "Executing: #{command}" if opts.verbose
+    system command
+  end
+else
+  puts "noarg"
+  map = NATPMP.map opts.port, opts.public, opts.ttl, opts.type
+end
+
+# vim: ft=ruby sts=2 sw=2 ts=8

data/lib/natpmp.rb

@@ -0,0 +1,138 @@
+# Simple NAT-PMP client
+# See: http://tools.ietf.org/html/rfc6886
+#
+require 'socket'
+
+class NATPMP
+  PMP_VERSION = 0
+  DEFAULT_LIFETIME  = 7200
+  DELAY_MSEC = 250
+  MAX_WAIT_SEC = 64
+  SERVER_PORT = 5351
+  CLIENT_PORT = 5350
+
+  OPCODE = { addr: 0, udp: 1, tcp: 2 }
+
+  # Return codes
+  #
+  RETCODE = { success: 0,     # Success
+	      unsupported: 1, # Unsupported Version
+	      refused: 2,     # Not Authorized/Refused (e.g., box supports mapping, but user has turned feature off)
+	      failed: 3,      # Network Failure (e.g., NAT box itself has not obtained a DHCP lease)
+	      exhausted: 4,   # Out of resources (NAT box cannot create any more mappings at this time)
+	      opnotsupp: 5    # Unsupported opcode
+	    }
+
+  # Determine the default gateway
+  #
+  def self.GW
+    return @gw if @gw
+    @gw = case RUBY_PLATFORM
+    when /darwin/
+      routes = `netstat -nrf inet`.split("\n").select{|l| l=~/^default/}
+      raise "Can't find default route" unless routes.size > 0
+      routes.first.split(/\s+/)[1]
+    when /linux/
+      routes = `ip route list match 0.0.0.0`.split("\n").select{|l| l =~ /^default/}
+      raise "Can't find default route" unless routes.size > 0
+      routes.first.split(/\s+/)[2]
+    else
+      raise "Platform not supported!"
+    end
+  end
+
+  def self.verbose flag = true
+    @verbose = flag
+  end
+
+  def self.verbose?
+    return @verbose
+  end
+
+  def self.send msg
+    sop = msg.unpack("xC").first
+    sock = UDPSocket.open
+    sock.connect(NATPMP.GW, SERVER_PORT)
+    cb = sock.send(msg, 0)
+    raise "Couldn't send!" unless cb == msg.size
+    delay = DELAY_MSEC/1000.0
+    begin
+      sleep delay # to give time for the response to arrive!
+      (reply, sendinfo) = sock.recvfrom_nonblock(16)
+      sender = Addrinfo.new sendinfo
+      raise "Being spoofed!" unless sender.ip_address == NATPMP.GW
+      (ver,op,res) = reply.unpack("CCn")
+      raise "Invalid version #{ver}" unless ver == PMP_VERSION
+      raise "Invalid reply opcode #{op}" unless op == 128 + sop
+      raise "Request failed (code #{RETCODE.key(res)})" unless res == RETCODE[:success]
+      return reply
+    rescue IO::WaitReadable
+      if delay < MAX_WAIT_SEC
+	puts "Retrying after #{delay}..." if NATPMP.verbose?
+        delay *= 2
+	retry
+      end
+      raise "Waited too long, got no response"
+    rescue Errno::ECONNREFUSED
+      raise "Remote NATPMP server not found"
+    end
+  end
+
+  # Return the externally facing IPv4 address
+  #
+  def self.addr
+    reply = self.send [0, OPCODE[:addr]].pack("CC")
+    sssoe = reply.unpack("x4N").first
+    addr = reply.unpack("x8CCCC")
+    return addr.join('.')
+  end
+
+  attr_reader :priv, :pub, :mapped, :maxlife, :life, :type
+
+  def initialize priv, pub, maxlife, type
+    @priv = priv
+    @pub = pub
+    @maxlife = maxlife
+    raise "Time must be >= 0" if maxlife < 0
+    @type = type
+
+    # These are filled in when a request is made
+    #
+    @life = 0
+    @mapped = 0
+  end
+
+  # See section 3.3
+  def request!
+    rsp = NATPMP.send [0, OPCODE[@type], 0, @priv, @pub, @maxlife].pack("CCnnnN")
+    (sssoe, priv, @mapped, @life) = rsp.unpack("x4NnnN")
+    raise "Port mismatch: requested #{@priv} received #{priv}" if @priv != priv
+    STDERR.puts "Mapped #{inspect}" if NATPMP.verbose
+  end
+
+  # See section 3.4
+  def revoke!
+    rsp = NATPMP.send [0, OPCODE[@type], 0, @priv, 0, 0].pack("CCnnnN")
+    STDERR.puts "Revoked #{inspect}" if NATPMP.verbose
+  end
+
+  def inspect
+    "#{NATPMP.GW}:#{@mapped}->#{@type}:#{@priv} (#{@life} sec)"
+  end
+
+  def self.map priv, pub, maxlife = DEFAULT_LIFETIME, type = :tcp, &block
+
+    map = NATPMP.new(priv, pub, maxlife, type)
+    map.request!
+    if block_given?
+      begin
+	yield map
+      ensure
+	map.revoke!
+        map = nil
+      end
+    end
+    return map
+
+  end
+end

data/lib/natpmp/version.rb

@@ -0,0 +1,3 @@
+class NATPMP
+  VERSION='0.8'
+end

data/test/test_natpmp.rb

@@ -0,0 +1,9 @@
+# Simple smoke test
+# To be improved!
+#
+require 'natpmp.rb'
+
+NATPMP.map 633, 13033, 30, :tcp do |map|
+  puts "Executing sleep 10 with #{map.inspect}"
+  sleep 10
+end

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification
+name: natpmp
+version: !ruby/object:Gem::Version
+  version: '0.8'
+platform: ruby
+authors:
+- Nick Townsend
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-11 00:00:00.000000000 Z
+dependencies: []
+description: Interface to NAT-PMP. Portable between Mac OS X and CentOS 5+.
+email:
+- nick.townsend@mac.com
+executables:
+- natpmp
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/natpmp.rb
+- bin/natpmp
+- lib/natpmp/version.rb
+- test/test_natpmp.rb
+homepage: https://github.com/townsen/c-pod/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.5
+signing_key: 
+specification_version: 4
+summary: Encapsulate NAT-PMP protocol
+test_files:
+- test/test_natpmp.rb