xmpp4r 0.3

data/lib/xmpp4r/bytestreams/helper/socks5bytestreams/base.rb

@@ -0,0 +1,151 @@
+require 'socket'
+require 'thread'
+require 'timeout'
+require 'digest/sha1'
+
+require 'callbacks'
+
+module Jabber
+  module Bytestreams
+    ##
+    # SOCKS5 Bytestreams (JEP-0065) implementation
+    #
+    # Don't use directly, use SOCKS5BytestreamsInitiator
+    # and SOCKS5BytestreamsTarget
+    class SOCKS5Bytestreams
+      ##
+      # [StreamHost] the SOCKS connection is using
+      attr_reader :streamhost_used
+
+      ##
+      # SOCKS connection timeout (for trying multiple streamhosts)
+      #
+      # default: nil, use the OS' default timeout
+      attr_accessor :connect_timeout
+      
+      def initialize(stream, session_id, initiator_jid, target_jid)
+        @stream = stream
+        @session_id = session_id
+        @initiator_jid = (initiator_jid.kind_of?(String) ? JID.new(initiator_jid) : initiator_jid)
+        @target_jid = (target_jid.kind_of?(String) ? JID.new(target_jid) : target_jid)
+        @socks = nil
+        @connect_timeout = nil
+        @streamhost_used = nil
+        @streamhost_cbs = CallbackList.new
+      end
+
+      ##
+      # Add a callback that will be called when there is action regarding
+      # SOCKS stream-hosts
+      #
+      # Usage of this callback is optional and serves informational purposes only.
+      #
+      # block takes three arguments:
+      # * The StreamHost instance that is currently being tried
+      # * State information (is either :connecting, :authenticating, :success or :failure)
+      # * The exception value for the state :failure, else nil
+      def add_streamhost_callback(priority = 0, ref = nil, &block)
+        @streamhost_cbs.add(priority, ref, block)
+      end
+
+      ##
+      # Receive from the stream-host
+      # length:: [Fixnum] Amount of bytes (Will be passed to TCPSocket#read for the underlying SOCKS5 connection)
+      # result:: [String] (or [nil] if finished)
+      def read(length=nil)
+        @socks.read(length)
+      end
+
+      ##
+      # Flush the SOCKS5 socket
+      def flush
+        @socks.flush
+      end
+
+      ##
+      # Send to the stream-host
+      # buf:: [String] Data
+      # result:: [Fixnum] Amount of bytes sent
+      def write(buf)
+        @socks.write(buf)
+        # FIXME: On FreeBSD this throws Errno::EPERM after it has already written a few
+        # kilobytes, and when there are multiple sockets. ktrace told, that this originates
+        # from the syscall, not ruby.
+      end
+
+      ##
+      # Close the stream-host connection
+      def close
+        @socks.close
+      end
+
+      ##
+      # Query a JID for its stream-host information
+      #
+      # SOCKS5BytestreamsInitiator#add_streamhost can do this for you.
+      # Use this method if you plan to do multiple transfers, so
+      # you can cache the result.
+      # stream:: [Stream] to operate on
+      # streamhost:: [JID] of the proxy
+      # my_jid:: [JID] Optional sender JID for Component operation
+      def self.query_streamhost(stream, streamhost, my_jid=nil)
+        res = nil
+
+        iq = Iq::new(:get, streamhost)
+        iq.from = my_jid
+        iq.add(IqQueryBytestreams.new)
+        stream.send_with_id(iq) { |reply|
+          if reply.type == :result
+            reply.query.each_element { |e|
+              if e.kind_of?(StreamHost)
+                e.jid = reply.from  # Help misconfigured proxys
+                res = e
+              end
+            }
+          end
+          true
+        }
+
+        if res and res.jid and res.host and res.port
+          res
+        else
+          nil
+        end
+      end
+
+      private
+
+      ##
+      # The address the stream-host expects from us.
+      # According to JEP-0096 this is the SHA1 hash
+      # of the concatenation of session_id,
+      # initiator_jid and target_jid.
+      # result:: [String] SHA1 hash
+      def stream_address
+        Digest::SHA1.new("#{@session_id}#{@initiator_jid}#{@target_jid}").hexdigest
+      end
+
+      ##
+      # Try a streamhost
+      # result:: [SOCKS5Socket]
+      def connect_socks(streamhost)
+        Timeout::timeout(@connect_timeout, Errno::ETIMEDOUT) {
+          Jabber::debuglog("SOCKS5 Bytestreams: connecting to proxy #{streamhost.jid} (#{streamhost.host}:#{streamhost.port})")
+          @streamhost_cbs.process(streamhost, :connecting, nil)
+          socks = SOCKS5Socket.new(streamhost.host, streamhost.port)
+
+          Jabber::debuglog("SOCKS5 Bytestreams: connected, authenticating")
+          @streamhost_cbs.process(streamhost, :authenticating, nil)
+          socks.auth
+
+          socks.connect_domain(stream_address, 0)
+
+          Jabber::debuglog("SOCKS5 Bytestreams: connected")
+          @streamhost_cbs.process(streamhost, :success, nil)
+
+          socks
+        }
+      end
+    end
+  end
+end

data/lib/xmpp4r/bytestreams/helper/socks5bytestreams/initiator.rb

@@ -0,0 +1,85 @@
+module Jabber
+  module Bytestreams
+    ##
+    # SOCKS5Bytestreams implementation for the initiator side
+    class SOCKS5BytestreamsInitiator < SOCKS5Bytestreams
+      attr_reader :streamhosts
+
+      def initialize(stream, session_id, initiator_jid, target_jid)
+        super
+        @streamhosts = []
+      end
+
+      ##
+      # Add a streamhost which will be offered to the target
+      #
+      # streamhost:: can be:
+      # * [StreamHost] if already got all information (host/port)
+      # * [SOCKS5BytestreamsServer] if this is the local streamhost
+      # * [String] or [JID] if information should be automatically resolved by SOCKS5Bytestreams::query_streamhost
+      def add_streamhost(streamhost)
+        if streamhost.kind_of?(StreamHost)
+          @streamhosts << streamhost
+        elsif streamhost.kind_of?(SOCKS5BytestreamsServer)
+          streamhost.each_streamhost(@initiator_jid) { |sh|
+            @streamhosts << sh
+          }
+        elsif streamhost.kind_of?(String) or streamhost.kind_of?(JID)
+          @streamhosts << SOCKS5Bytestreams::query_streamhost(@stream, streamhost, @initiator_jid)
+        else
+          raise "Unknwon streamhost type: #{streamhost.class}"
+        end
+      end
+
+      ##
+      # Send the configured streamhosts to the target,
+      # wait for an answer and
+      # connect to the host the target chose.
+      def open
+        iq1 = Iq::new(:set, @target_jid)
+        iq1.from = @initiator_jid
+        bs = iq1.add IqQueryBytestreams.new(@session_id)
+        @streamhosts.each { |se|
+          bs.add(se)
+        }
+
+        peer_used = nil
+        @stream.send_with_id(iq1) { |response|
+          if response.type == :result and response.query.kind_of?(IqQueryBytestreams)
+            peer_used = response.query.streamhost_used
+            raise "No streamhost-used" unless peer_used
+            raise "Invalid streamhost-used" unless peer_used.jid
+          end
+          true
+        }
+
+        @streamhost_used = nil
+        @streamhosts.each { |sh|
+          if peer_used.jid == sh.jid
+            @streamhost_used = sh
+            break
+          end
+        }
+        if @streamhost_used.jid == @initiator_jid
+          # This is our own JID, so the target chose SOCKS5BytestreamsServer
+          @socks = @streamhost_used.server.peer_sock(stream_address)
+          raise "Target didn't connect" unless @socks
+          @streamhost_cbs.process(@streamhost_used, :success, nil)
+        else
+          begin
+            @socks = connect_socks(@streamhost_used)
+          rescue Exception => e
+            Jabber::debuglog("SOCKS5 Bytestreams: #{e.class}: #{e}\n#{e.backtrace.join("\n")}")
+            @streamhost_cbs.process(@streamhost_used, :failure, e)
+            raise e
+          end
+          iq2 = Iq::new(:set, @streamhost_used.jid)
+          iq2.add(IqQueryBytestreams.new(@session_id)).activate = @target_jid.to_s
+          @stream.send_with_id(iq2) { |reply|
+            reply.type == :result
+          }
+        end
+      end
+    end
+  end
+end

data/lib/xmpp4r/bytestreams/helper/socks5bytestreams/server.rb

@@ -0,0 +1,178 @@
+module Jabber
+  module Bytestreams
+    ##
+    # The SOCKS5BytestreamsServer is an implementation of a SOCKS5 server.
+    #
+    # You can use it if you're reachable by your SOCKS5Bytestreams peers,
+    # thus avoiding use of an external proxy.
+    #
+    # ==Usage:
+    # * Instantiate with an unfirewalled port
+    # * Add your external IP addresses with SOCKS5BytestreamsServer#add_address
+    # * Once you've got an *outgoing* SOCKS5BytestreamsInitiator, do
+    #   <tt>SOCKS5BytestreamsInitiator#add_streamhost(my_socks5bytestreamsserver)</tt>
+    #   *before* you do <tt>SOCKS5BytestreamsInitiator#open</tt>
+    class SOCKS5BytestreamsServer
+      ##
+      # Start a local SOCKS5BytestreamsServer
+      #
+      # Will start to listen on the given TCP port and
+      # accept new peers
+      # port:: [Fixnum] TCP port to listen on
+      def initialize(port)
+        @port = port
+        @addresses = []
+        @peers = []
+        @peers_lock = Mutex.new
+        socket = TCPServer.new(port)
+
+        Thread.new {
+          loop {
+            peer = SOCKS5BytestreamsPeer.new(socket.accept)
+            Thread.new {
+              begin
+                peer.start
+              rescue
+                Jabber::debuglog("SOCKS5 BytestreamsServer: Error accepting peer: #{$!}")
+              end
+            }
+            @peers_lock.synchronize {
+              @peers << peer
+            }
+          }
+        }
+      end
+
+      ##
+      # Find the socket a peer is associated to
+      # addr:: [String] Address like SOCKS5Bytestreams#stream_address
+      # result:: [TCPSocker] or [nil]
+      def peer_sock(addr)
+        res = nil
+        @peers_lock.synchronize {
+          removes = []
+
+          @peers.each { |peer|
+            if peer.socket and peer.socket.closed?
+              # Queue peers with closed socket for removal
+              removes << peer
+            elsif peer.address == addr and res.nil?
+              res = peer.socket
+            else
+              # If we sent multiple addresses of our own, clients may
+              # connect multiple times. Close these connections here.
+              removes << peer
+            end
+          }
+
+          # If we sent multiple addresses of our own, clients may
+          # connect multiple times. Close these connections here.
+          @peers.delete_if { |peer|
+            if removes.include? peer
+              peer.socket.close rescue IOError
+              true
+            else
+              false
+            end
+          }
+        }
+
+        res
+      end
+
+      ##
+      # Add an external IP address
+      #
+      # This is a must-have, as SOCKS5BytestreamsInitiator must inform
+      # the target where to connect
+      def add_address(address)
+        @addresses << address
+      end
+
+      ##
+      # Iterate through all configured addresses,
+      # yielding SOCKS5BytestreamsServerStreamHost
+      # instances, which should be passed to
+      # SOCKS5BytestreamsInitiator#add_streamhost
+      #
+      # This will be automatically invoked if you pass an instance
+      # of SOCKS5BytestreamsServer to
+      # SOCKS5BytestreamsInitiator#add_streamhost
+      # my_jid:: [JID] My Jabber-ID
+      def each_streamhost(my_jid, &block)
+        @addresses.each { |address|
+          yield SOCKS5BytestreamsServerStreamHost.new(self, my_jid, address, @port)
+        }
+      end
+    end
+
+    ##
+    # A subclass of StreamHost which possesses a
+    # server attribute, to let SOCKS5BytestreamsInitiator
+    # know this is the local SOCKS5BytestreamsServer
+    class SOCKS5BytestreamsServerStreamHost < StreamHost
+      attr_reader :server
+      def initialize(server, jid=nil, host=nil, port=nil)
+        super(jid, host, port)
+        @server = server
+      end
+    end
+
+    ##
+    # This class will be instantiated by SOCKS5BytestreamsServer
+    # upon accepting a new connection
+    class SOCKS5BytestreamsPeer
+      attr_reader :address, :socket
+
+      ##
+      # Initialize a new peer
+      # socket:: [TCPSocket]
+      def initialize(socket)
+        @socket = socket
+        Jabber::debuglog("SOCKS5 BytestreamsServer: accepted peer #{@socket.peeraddr[2]}:#{@socket.peeraddr[1]}")
+      end
+
+      ##
+      # Start handshake process
+      def start
+        auth_ver = @socket.getc
+        if auth_ver != 5
+          # Unsupported version
+          @socket.close
+          return
+        end
+
+        auth_nmethods = @socket.getc
+        auth_methods = @socket.read(auth_nmethods)
+        unless auth_methods.index("\x00")
+          # Client won't accept no authentication
+          @socket.write("\x05\xff")
+          @socket.close
+          return
+        end
+        @socket.write("\x05\x00")
+        Jabber::debuglog("SOCKS5 BytestreamsServer: peer #{@socket.peeraddr[2]}:#{@socket.peeraddr[1]} authenticated")
+
+        req = @socket.read(4)
+        if req != "\x05\x01\x00\x03"
+          # Unknown version, command, reserved, address-type
+          @socket.close
+          return
+        end
+        req_addrlen = @socket.getc
+        req_addr = @socket.read(req_addrlen)
+        req_port = @socket.read(2)
+        if req_port != "\x00\x00"
+          # Port is not 0
+          @socket.write("\x05\x01")
+          @socket.close
+          return
+        end
+        @socket.write("\x05\x00\x00\x03#{req_addrlen.chr}#{req_addr}\x00\x00")
+        Jabber::debuglog("SOCKS5 BytestreamsServer: peer #{@socket.peeraddr[2]}:#{@socket.peeraddr[1]} connected for #{req_addr}")
+
+        @address = req_addr
+      end
+    end
+  end
+end

data/lib/xmpp4r/bytestreams/helper/socks5bytestreams/socks5.rb

@@ -0,0 +1,56 @@
+require 'socket'
+
+module Jabber
+  module Bytestreams
+    ##
+    # Can be thrown upon communication error with
+    # a SOCKS5 proxy
+    class SOCKS5Error < RuntimeError; end
+
+    ##
+    # A SOCKS5 client implementation
+    #
+    # ==Usage:
+    # * Initialize with proxy's address and port
+    # * Authenticate
+    # * Connect to target host
+    class SOCKS5Socket < TCPSocket
+      ##
+      # Connect to SOCKS5 proxy
+      def initialize(socks_host, socks_port)
+        super(socks_host, socks_port)
+      end
+
+      ##
+      # Authenticate for SOCKS5 proxy
+      #
+      # Currently supports only 'no authentication required'
+      def auth
+        write("\x05\x01\x00")
+        buf = read(2)
+        if buf.nil? or buf != "\x05\x00"
+          close
+          raise SOCKS5Error.new("Invalid SOCKS5 authentication: #{buf.inspect}")
+        end
+
+        self
+      end
+
+      ##
+      # Issue a CONNECT request to a host name
+      # which is to be resolved by the proxy.
+      # domain:: [String] Host name
+      # port:: [Fixnum] Port number
+      def connect_domain(domain, port)
+        write("\x05\x01\x00\x03#{domain.size.chr}#{domain}#{[port].pack("n")}")
+        buf = read(7 + domain.size)
+        if buf.nil? or buf[0..1] != "\005\000"
+          close
+          raise SOCKS5Error.new("Invalid SOCKS5 connect: #{buf.inspect}")
+        end
+
+        self
+      end
+    end
+  end
+end

data/lib/xmpp4r/bytestreams/helper/socks5bytestreams/target.rb

@@ -0,0 +1,61 @@
+module Jabber
+  module Bytestreams
+    ##
+    # SOCKS5 Bytestreams implementation of the target site
+    class SOCKS5BytestreamsTarget < SOCKS5Bytestreams
+      ##
+      # Wait until the stream has been established
+      #
+      # May raise various exceptions
+      def accept
+        error = nil
+        connect_lock = Mutex.new
+        connect_lock.lock
+
+        @stream.add_iq_callback(200, self) { |iq|
+          if iq.type == :set and iq.from == @initiator_jid and iq.to == @target_jid and iq.query.kind_of?(IqQueryBytestreams)
+            begin
+              @stream.delete_iq_callback(self)
+
+              iq.query.each_element('streamhost') { |streamhost|
+                if streamhost.host and streamhost.port and not @socks
+                  begin
+                    @socks = connect_socks(streamhost)
+                    @streamhost_used = streamhost
+                  rescue Exception => e
+                    Jabber::debuglog("SOCKS5 Bytestreams: #{e.class}: #{e}\n#{e.backtrace.join("\n")}")
+                    @streamhost_cbs.process(streamhost, :failure, e)
+                  end
+                end
+              }
+
+              reply = iq.answer(false)
+              if @streamhost_used
+                reply.type = :result
+                reply.add(IqQueryBytestreams.new)
+                reply.query.add(StreamHostUsed.new(@streamhost_used.jid))
+              else
+                reply.type = :error
+                reply.add(Error.new('item-not-found'))
+              end
+              @stream.send(reply)
+            rescue Exception => e
+              error = e
+            end
+              
+            connect_lock.unlock
+            true
+          else
+            false
+          end
+        }
+
+        connect_lock.lock
+        connect_lock.unlock
+        raise error if error
+        (@socks != nil)
+      end
+    end
+  end
+end
+

data/lib/xmpp4r/bytestreams/iq/bytestreams.rb

@@ -0,0 +1,177 @@
+# =XMPP4R - XMPP Library for Ruby
+# License:: Ruby's license (see the LICENSE file) or GNU GPL, at your option.
+# Website::http://home.gna.org/xmpp4r/
+
+module Jabber
+  module Bytestreams
+    ##
+    # Class for accessing <query/> elements with
+    # xmlns='http://jabber.org/protocol/bytestreams'
+    # in <iq/> stanzas.
+    class IqQueryBytestreams < IqQuery
+      NS_BYTESTREAMS = 'http://jabber.org/protocol/bytestreams'
+
+      ##
+      # Initialize such a <query/>
+      # sid:: [String] Session-ID
+      # mode:: [Symbol] :tcp or :udp
+      def initialize(sid=nil, mode=nil)
+        super()
+        add_namespace(IqQueryBytestreams::NS_BYTESTREAMS)
+        self.sid = sid
+        self.mode = mode
+      end
+
+      def typed_add(xe)
+        if xe.kind_of?(REXML::Element) and xe.name == 'streamhost'
+          super StreamHost.new.import(xe)
+        elsif xe.kind_of?(REXML::Element) and xe.name == 'streamhost-used'
+          super StreamHostUsed.new.import(xe)
+        else
+          super xe
+        end
+      end
+
+      ##
+      # Session-ID
+      def sid
+        attributes['sid']
+      end
+
+      ##
+      # Set Session-ID
+      def sid=(s)
+        attributes['sid'] = s
+      end
+
+      ##
+      # Transfer mode
+      # result:: :tcp or :udp
+      def mode
+        case attributes['mode']
+          when 'udp' then :udp
+          else :tcp
+        end
+      end
+
+      ##
+      # Set the transfer mode
+      # m:: :tcp or :udp
+      def mode=(m)
+        case m
+          when :udp then attributes['mode'] = 'udp'
+          else attributes['mode'] = 'tcp'
+        end
+      end
+
+      ##
+      # Get the <streamhost-used/> child
+      # result:: [StreamHostUsed]
+      def streamhost_used
+        first_element('streamhost-used')
+      end
+
+      ##
+      # Get the text of the <activate/> child
+      # result:: [JID] or [nil]
+      def activate
+        j = first_element_text('activate')
+        j ? JID.new(j) : nil
+      end
+
+      ##
+      # Set the text of the <activate/> child
+      # s:: [JID]
+      def activate=(s)
+        replace_element_text('activate', s ? s.to_s : nil)
+      end
+    end
+
+    IqQuery.add_namespaceclass(IqQueryBytestreams::NS_BYTESTREAMS, IqQueryBytestreams)
+
+    ##
+    # <streamhost/> element, normally appear
+    # as children of IqQueryBytestreams
+    class StreamHost < REXML::Element
+      ##
+      # Initialize a <streamhost/> element
+      # jid:: [JID]
+      # host:: [String] Hostname or IP address
+      # port:: [Fixnum] Port number
+      def initialize(jid=nil, host=nil, port=nil)
+        super('streamhost')
+        self.jid = jid
+        self.host = host
+        self.port = port
+      end
+
+      ##
+      # Get the JID of the streamhost
+      def jid
+        (a = attributes['jid']) ? JID.new(a) : nil
+      end
+
+      ##
+      # Set the JID of the streamhost
+      def jid=(j)
+        attributes['jid'] = (j ? j.to_s : nil)
+      end
+
+      ##
+      # Get the host address of the streamhost
+      def host
+        attributes['host']
+      end
+
+      ##
+      # Set the host address of the streamhost
+      def host=(h)
+        attributes['host'] = h
+      end
+
+      ##
+      # Get the zeroconf attribute of the streamhost
+      def zeroconf
+        attributes['zeroconf']
+      end
+
+      ##
+      # Set the zeroconf attribute of the streamhost
+      def zeroconf=(s)
+        attributes['zeroconf'] = s
+      end
+
+      ##
+      # Get the port number of the streamhost
+      def port
+        p = attributes['port'].to_i
+        (p == 0 ? nil : p)
+      end
+
+      ##
+      # Set the port number of the streamhost
+      def port=(p)
+        attributes['port'] = p.to_s
+      end
+    end
+
+    ##
+    # <streamhost-used/> element, normally appears
+    # as child of IqQueryBytestreams
+    class StreamHostUsed < REXML::Element
+      def initialize(jid=nil)
+        super('streamhost-used')
+        self.jid = jid
+      end
+
+      def jid
+        (a = attributes['jid']) ? JID.new(a) : nil
+      end
+
+      def jid=(j)
+        attributes['jid'] = (j ? j.to_s : nil)
+      end
+    end
+  end
+end
+