UPnP-IGD 1.0.0

data/History.txt

@@ -0,0 +1,6 @@
+=== 1.0.0 / 2008-06-28
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,9 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/upnp_igd
+lib/UPnP/control/device/internet_gateway_device.rb
+lib/UPnP/control/service/layer_3_forwarding.rb
+lib/UPnP/control/service/wan_common_interface_config.rb
+lib/UPnP/control/service/wan_ip_connection.rb

data/README.txt

@@ -0,0 +1,71 @@
+= UPnP-IGD
+
+* http://seattlerb.org/UPnP-IGD
+* Eric Hodel drbrain@segment7.net
+* http://www.upnp.org/standardizeddcps/igd.asp
+* Bugs: http://rubyforge.org/tracker/?atid=5921&group_id=1513
+
+== DESCRIPTION:
+
+A UPnP extension for Internet Gateway Devices
+
+== FEATURES/PROBLEMS:
+
+* Command-line utility that displays information about a UPnP gateway
+* Example of using some UPnP APIs
+* Does not set anything on the device
+* Only tested against miniupnpd
+
+== SYNOPSIS:
+
+  $ upnp_igd
+  Gateway at http://10.1.1.1/
+  Connected, up since 2008-06-29 03:31:00 (66123 seconds)
+  Connection type: IP_Routed
+  384 Kb/s up, 1536 Kb/s down
+  External IP address: 10.255.255.254
+  
+  Port mappings:
+  0 UDP *:4502  -> 10.1.1.2:4500  "iC4502"
+  1 UDP *:5355  -> 10.1.1.2:5353  "iC5355"
+  2 UDP *:58712 -> 10.1.1.3:58712 "Skype UDP at 10.1.1.3:58712 (546)"
+  3 TCP *:58712 -> 10.1.1.3:58712 "Skype TCP at 10.1.1.3:58712 (546)"
+  4 UDP *:5353  -> 10.1.1.4:5353  "iC5353"
+
+== REQUIREMENTS:
+
+* A UPnP gateway device
+
+== INSTALL:
+
+* sudo gem install UPnP-IGD
+
+== LICENSE:
+
+All code copyright 2008 Eric Hodel.  All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+
+1. Redistributions of source code must retain the above copyright
+   notice, this list of conditions and the following disclaimer.
+2. 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.
+3. Neither the names of the authors nor the names of their contributors
+   may be used to endorse or promote products derived from this software
+   without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``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 AUTHORS 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/Rakefile

@@ -0,0 +1,14 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+$:.unshift 'lib'
+require 'UPnP/control/device/internet_gateway_device'
+
+Hoe.new('UPnP-IGD',
+        UPnP::Control::Device::InternetGatewayDevice::VERSION) do |p|
+  p.rubyforge_name = 'seattlerb'
+  p.developer('Eric Hodel', 'drbrain@segment7.net')
+end
+
+# vim: syntax=Ruby

data/bin/upnp_igd

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+
+require 'UPnP/control/device/internet_gateway_device'
+
+ssdp = UPnP::SSDP.new
+timeout = ARGV.shift
+timeout = if timeout then
+            begin
+              timeout = Integer timeout
+            rescue
+              abort <<-EOF
+Usage: #{$0} [timeout]
+
+Prints information about UPnP internet gateway devices
+              EOF
+            end
+          else
+            1
+          end
+
+ssdp.timeout = timeout
+
+gateways = UPnP::Control::Device::InternetGatewayDevice.search ssdp
+
+if gateways.empty? then
+  puts 'No internet gateway devices found'
+else
+  gateways.each do |igd| igd.print_info end
+end
+

data/lib/UPnP/control/device/internet_gateway_device.rb

@@ -0,0 +1,125 @@
+require 'rubygems'
+require 'UPnP/control/device'
+require 'UPnP/control/service/layer_3_forwarding'
+require 'UPnP/control/service/wan_ip_connection'
+require 'UPnP/control/service/wan_common_interface_config'
+
+##
+# A UPnP Internet Gateway Device control point that provides friendly
+# accessors to its component services and provides a handy method to dump
+# information about the device.
+#
+# http://www.upnp.org/standardizeddcps/igd.asp
+
+class UPnP::Control::Device::InternetGatewayDevice < UPnP::Control::Device
+
+  ##
+  # The version of UPnP-IGD you are using
+
+  VERSION = '1.0.0'
+
+  ##
+  # Version 1 URN for InternetGatewayDevice
+
+  URN_1 = [UPnP::DEVICE_SCHEMA_PREFIX, name.split(':').last, 1].join ':'
+
+  ##
+  # Prints a summary of this gateway devices status to $stdout
+
+  def print_info
+    puts "Gateway at #{presentation_url || url}"
+
+    status, last_error, uptime = wic.GetStatusInfo
+
+    up_at = (Time.now - uptime).strftime "%Y-%m-%d %H:%M:%S"
+    puts "#{status}, up since #{up_at} (#{uptime} seconds)"
+
+    case status
+    when 'Connected', 'PendingDisconnect' then
+      connection_type, = wic.GetConnectionTypeInfo
+      puts "Connection type: #{connection_type}"
+
+      _, upstream, downstream, = wcic.GetCommonLinkProperties
+      puts "#{upstream / 1024} Kb/s up, #{downstream / 1024} Kb/s down"
+
+      external_ip = wic.GetExternalIPAddress
+      puts "External IP address: #{external_ip}"
+
+      port_mappings = wic.port_mappings
+
+      index_length = port_mappings.length.to_s.length
+
+      e_host_length = port_mappings.map { |port| port[0].length }.max
+      e_host_length = 1 if e_host_length.zero?
+
+      i_host_length = port_mappings.map { |port| port[4].length }.max
+
+      puts
+      puts "Port mappings:"
+      port_mappings.each_with_index do |port, i|
+        e_host, e_port, proto, i_port, i_host, enabled, descr, duration = port
+        e_host = '*' if e_host.empty?
+
+        puts "%*d %s %*s:%-5d -> %*s:%-5d \"%s\"" % [
+          index_length, i,
+          proto,
+          e_host_length, e_host, e_port,
+          i_host_length, i_host, i_port,
+          descr
+        ]
+      end
+    end
+
+    puts
+  end
+
+  ##
+  # An accessor for the Layer3Forwarding service
+
+  def layer_3_forwarding
+    @l3f ||= services.find do |service|
+      service.type == UPnP::Control::Service::Layer3Forwarding::URN_1
+    end
+
+    @l3f
+  end
+
+  ##
+  # An accessor for the Layer3Forwarding service
+
+  alias l3f layer_3_forwarding
+
+  ##
+  # An accessor for the WANCommonInterfaceConfig service
+
+  def wan_common_interface_config
+    @wcic ||= services.find do |service|
+      UPnP::Control::Service::WANCommonInterfaceConfig === service
+    end
+
+    @wcic
+  end
+
+  ##
+  # An accessor for the WANCommonInterfaceConfig service
+
+  alias wcic wan_common_interface_config
+
+  ##
+  # An accessor for the WANIPConnection service
+
+  def wan_ip_connection
+    @wip ||= services.find do |service|
+      UPnP::Control::Service::WANIPConnection === service
+    end
+
+    @wip
+  end
+
+  ##
+  # An accessor for the WANIPConnection service
+
+  alias wic wan_ip_connection
+
+end
+

data/lib/UPnP/control/service/layer_3_forwarding.rb

@@ -0,0 +1,16 @@
+require 'rubygems'
+require 'UPnP/control/service'
+
+##
+# The UPnP Layer 3 Forwarding service models layer-3 packet forwarding
+# services for a WANDevice.
+
+class UPnP::Control::Service::Layer3Forwarding < UPnP::Control::Service
+
+  ##
+  # Version 1 URN for the Layer3Forwarding service
+
+  URN_1 = [UPnP::SERVICE_SCHEMA_PREFIX, name.split(':').last, 1].join ':'
+
+end
+

data/lib/UPnP/control/service/wan_common_interface_config.rb

@@ -0,0 +1,16 @@
+require 'rubygems'
+require 'UPnP/control/service'
+
+##
+# A UPnP WAN Common Interface Config service models the physical layer
+# properties of a WAN interface on an InternetGatewayDevice.
+
+class UPnP::Control::Service::WANCommonInterfaceConfig < UPnP::Control::Service
+
+  ##
+  # Version 1 URN for the WANCommonInterfaceConfig service
+
+  URN_1 = [UPnP::SERVICE_SCHEMA_PREFIX, name.split(':').last, 1].join ':'
+
+end
+

data/lib/UPnP/control/service/wan_ip_connection.rb

@@ -0,0 +1,35 @@
+require 'rubygems'
+require 'UPnP/control/service'
+
+##
+# The UPnP WAN IP Connection service.
+#
+# This service is used to configure and control IP connections on the WAN
+# device of an InternetGatewayDevice.
+
+class UPnP::Control::Service::WANIPConnection < UPnP::Control::Service
+
+  ##
+  # Version 1 URN for the WANIPConnection
+
+  URN_1 = [UPnP::SERVICE_SCHEMA_PREFIX, name.split(':').last, 1].join ':'
+
+  ##
+  # Collects all the port mappings via GetGenericPortMappingEntry and returns
+  # an Array containing each response.
+
+  def port_mappings
+    port_mappings = []
+    i = 0
+
+    loop do
+      port_mappings << GetGenericPortMappingEntry(i)
+      i += 1
+    end
+  rescue UPnP::Control::Service::UPnPError => e
+    raise unless e.code == 713
+    port_mappings
+  end
+
+end
+

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification 
+name: UPnP-IGD
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Eric Hodel
+autorequire: 
+bindir: bin
+cert_chain: 
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDNjCCAh6gAwIBAgIBADANBgkqhkiG9w0BAQUFADBBMRAwDgYDVQQDDAdkcmJy
+  YWluMRgwFgYKCZImiZPyLGQBGRYIc2VnbWVudDcxEzARBgoJkiaJk/IsZAEZFgNu
+  ZXQwHhcNMDcxMjIxMDIwNDE0WhcNMDgxMjIwMDIwNDE0WjBBMRAwDgYDVQQDDAdk
+  cmJyYWluMRgwFgYKCZImiZPyLGQBGRYIc2VnbWVudDcxEzARBgoJkiaJk/IsZAEZ
+  FgNuZXQwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCbbgLrGLGIDE76
+  LV/cvxdEzCuYuS3oG9PrSZnuDweySUfdp/so0cDq+j8bqy6OzZSw07gdjwFMSd6J
+  U5ddZCVywn5nnAQ+Ui7jMW54CYt5/H6f2US6U0hQOjJR6cpfiymgxGdfyTiVcvTm
+  Gj/okWrQl0NjYOYBpDi+9PPmaH2RmLJu0dB/NylsDnW5j6yN1BEI8MfJRR+HRKZY
+  mUtgzBwF1V4KIZQ8EuL6I/nHVu07i6IkrpAgxpXUfdJQJi0oZAqXurAV3yTxkFwd
+  g62YrrW26mDe+pZBzR6bpLE+PmXCzz7UxUq3AE0gPHbiMXie3EFE0oxnsU3lIduh
+  sCANiQ8BAgMBAAGjOTA3MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQW
+  BBS5k4Z75VSpdM0AclG2UvzFA/VW5DANBgkqhkiG9w0BAQUFAAOCAQEAHagT4lfX
+  kP/hDaiwGct7XPuVGbrOsKRVD59FF5kETBxEc9UQ1clKWngf8JoVuEoKD774dW19
+  bU0GOVWO+J6FMmT/Cp7nuFJ79egMf/gy4gfUfQMuvfcr6DvZUPIs9P/TlK59iMYF
+  DIOQ3DxdF3rMzztNUCizN4taVscEsjCcgW6WkUJnGdqlu3OHWpQxZBJkBTjPCoc6
+  UW6on70SFPmAy/5Cq0OJNGEWBfgD9q7rrs/X8GGwUWqXb85RXnUVi/P8Up75E0ag
+  14jEc90kN+C7oI/AGCBN0j6JnEtYIEJZibjjDJTSMWlUKKkj30kq7hlUC2CepJ4v
+  x52qPcexcYZR7w==
+  -----END CERTIFICATE-----
+
+date: 2008-06-29 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.5.3
+    version: 
+description: A UPnP extension for Internet Gateway Devices
+email: 
+- drbrain@segment7.net
+executables: 
+- upnp_igd
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- bin/upnp_igd
+- lib/UPnP/control/device/internet_gateway_device.rb
+- lib/UPnP/control/service/layer_3_forwarding.rb
+- lib/UPnP/control/service/wan_common_interface_config.rb
+- lib/UPnP/control/service/wan_ip_connection.rb
+has_rdoc: true
+homepage: http://seattlerb.org/UPnP-IGD
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: seattlerb
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: A UPnP extension for Internet Gateway Devices
+test_files: []
+