gmcmillan-xmpp4r 0.5

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

@@ -0,0 +1,257 @@
+# =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/
+
+require 'xmpp4r/base64'
+
+module Jabber
+  module Bytestreams
+    ##
+    # In-Band Bytestreams (JEP-0047) implementation
+    #
+    # Don't use directly, use IBBInitiator and IBBTarget
+    #
+    # In-Band Bytestreams should only be used when transferring
+    # very small amounts of binary data, because it is slow and
+    # increases server load drastically.
+    #
+    # Note that the constructor takes a lot of arguments. In-Band
+    # Bytestreams do not specify a way to initiate the stream,
+    # this should be done via Stream Initiation.
+    class IBB
+      NS_IBB = 'http://jabber.org/protocol/ibb'
+
+      ##
+      # Create a new bytestream
+      #
+      # Will register a <message/> callback to intercept data
+      # of this stream. This data will be buffered, you can retrieve
+      # it with receive
+      def initialize(stream, session_id, my_jid, peer_jid)
+        @stream = stream
+        @session_id = session_id
+        @my_jid = (my_jid.kind_of?(String) ? JID.new(my_jid) : my_jid)
+        @peer_jid = (peer_jid.kind_of?(String) ? JID.new(peer_jid) : peer_jid)
+
+        @active = false
+        @seq_send = 0
+        @seq_recv = 0
+        @queue = []
+        @queue_lock = Mutex.new
+        @pending = Semaphore.new
+        @sendbuf = ''
+        @sendbuf_lock = Mutex.new
+
+        @block_size = 4096  # Recommended by JEP0047
+      end
+
+      def active?
+        @active
+      end
+
+      ##
+      # Send data
+      #
+      # Data is buffered to match block_size in each packet.
+      # If you need the data to be sent immediately, use
+      # flush afterwards.
+      # buf:: [String]
+      def write(buf)
+        @sendbuf_lock.synchronize {
+          @sendbuf += buf
+
+          while @sendbuf.size >= @block_size
+            send_data(@sendbuf[0..@block_size-1])
+            @sendbuf = @sendbuf[@block_size..-1].to_s
+          end
+        }
+      end
+
+      ##
+      # Empty the send-buffer by sending remaining data
+      def flush
+        @sendbuf_lock.synchronize {
+          while @sendbuf.size > 0
+            send_data(@sendbuf[0..@block_size-1])
+            @sendbuf = @sendbuf[@block_size..-1].to_s
+          end
+        }
+      end
+
+      ##
+      # Receive data
+      #
+      # Will wait until the Message with the next sequence number
+      # is in the stanza queue.
+      def read
+        if active?
+          res = nil
+
+          while res.nil?
+            @queue_lock.synchronize {
+              @queue.each { |item|
+                # Find next data
+                if item.type == :data and item.seq == @seq_recv.to_s
+                  res = item
+                  break
+                # No data? Find close
+                elsif item.type == :close and res.nil?
+                  res = item
+                end
+              }
+
+              @queue.delete_if { |item| item == res }
+            }
+
+            # No data? Wait for next to arrive...
+            @pending.wait unless res
+          end
+
+          if res.type == :data
+            @seq_recv += 1
+            @seq_recv = 0 if @seq_recv > 65535
+            res.data
+          elsif res.type == :close
+            deactivate
+            nil # Closed
+          end
+        else
+          nil
+        end
+      end
+
+      ##
+      # Close the stream
+      #
+      # Waits for acknowledge from peer,
+      # may throw ServerError
+      def close
+        if active?
+          flush
+          deactivate
+
+          iq = Iq.new(:set, @peer_jid)
+          close = iq.add REXML::Element.new('close')
+          close.add_namespace IBB::NS_IBB
+          close.attributes['sid'] = @session_id
+
+          @stream.send_with_id(iq)
+        end
+      end
+
+      private
+
+      ##
+      # Send data directly
+      # data:: [String]
+      def send_data(databuf)
+        if active?
+          msg = Message.new
+          msg.from = @my_jid
+          msg.to = @peer_jid
+
+          data = msg.add REXML::Element.new('data')
+          data.add_namespace NS_IBB
+          data.attributes['sid'] = @session_id
+          data.attributes['seq'] = @seq_send.to_s
+          data.text = Base64::encode64(databuf)
+
+          # TODO: Implement AMP correctly
+          amp = msg.add REXML::Element.new('amp')
+          amp.add_namespace 'http://jabber.org/protocol/amp'
+          deliver_at = amp.add REXML::Element.new('rule')
+          deliver_at.attributes['condition'] = 'deliver-at'
+          deliver_at.attributes['value'] = 'stored'
+          deliver_at.attributes['action'] = 'error'
+          match_resource = amp.add REXML::Element.new('rule')
+          match_resource.attributes['condition'] = 'match-resource'
+          match_resource.attributes['value'] = 'exact'
+          match_resource.attributes['action'] = 'error'
+
+          @stream.send(msg)
+
+          @seq_send += 1
+          @seq_send = 0 if @seq_send > 65535
+        else
+          raise 'Attempt to send data when not activated'
+        end
+      end
+
+      def activate
+        unless active?
+          @stream.add_message_callback(200, self) { |msg|
+            data = msg.first_element('data')
+            if msg.from == @peer_jid and msg.to == @my_jid and data and data.attributes['sid'] == @session_id
+              if msg.type == nil
+                @queue_lock.synchronize {
+                  @queue.push IBBQueueItem.new(:data, data.attributes['seq'], data.text.to_s)
+                  @pending.run
+                }
+              elsif msg.type == :error
+                @queue_lock.synchronize {
+                  @queue << IBBQueueItem.new(:close)
+                  @pending.run
+                }
+              end
+              true
+            else
+              false
+            end
+          }
+
+          @stream.add_iq_callback(200, self) { |iq|
+            close = iq.first_element('close')
+            if iq.type == :set and close and close.attributes['sid'] == @session_id
+              answer = iq.answer(false)
+              answer.type = :result
+              @stream.send(answer)
+
+              @queue_lock.synchronize {
+                @queue << IBBQueueItem.new(:close)
+                @pending.run
+              }
+              true
+            else
+              false
+            end
+          }
+
+          @active = true
+        end
+      end
+
+      def deactivate
+        if active?
+          @stream.delete_message_callback(self)
+          @stream.delete_iq_callback(self)
+
+          @active = false
+        end
+      end
+    end
+
+    ##
+    # Represents an item in the internal data queue
+    class IBBQueueItem
+      attr_reader :type, :seq
+      def initialize(type, seq=nil, data_text='')
+        unless [:data, :close].include? type
+          raise "Unknown IBBQueueItem type: #{type}"
+        end
+
+        @type = type
+        @seq = seq
+        @data = data_text
+      end
+
+      ##
+      # Return the Base64-*decoded* data
+      #
+      # There's no need to catch Exceptions here,
+      # as none are thrown.
+      def data
+        Base64::decode64(@data)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# =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
+    ##
+    # Implementation of IBB at the initiator side
+    class IBBInitiator < IBB
+      # You may set the block-size before open
+      attr_accessor :block_size
+
+      ##
+      # Open the stream to the peer,
+      # waits for successful result
+      #
+      # May throw ServerError
+      def open
+        iq = Iq.new(:set, @peer_jid)
+        open = iq.add REXML::Element.new('open')
+        open.add_namespace IBB::NS_IBB
+        open.attributes['sid'] = @session_id
+        open.attributes['block-size'] = @block_size.to_s
+
+        @stream.send_with_id(iq)
+
+        activate
+      end
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+# =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
+    ##
+    # Implementation of IBB at the target side
+    class IBBTarget < IBB
+      # You may read the block-size after accept
+      attr_reader :block_size
+
+      def initialize(stream, session_id, initiator_jid, target_jid)
+        # Target and Initiator are swapped here, because we're the target
+        super(stream, session_id, target_jid, initiator_jid)
+        @accept_ready = Semaphore::new
+      end
+
+      def accept_wait
+        @accept_ready.wait
+      end
+
+      ##
+      # Wait for the initiator side to start
+      # the stream.
+      def accept
+        connect_sem = Semaphore.new
+
+        @stream.add_iq_callback(200, self) { |iq|
+          open = iq.first_element('open')
+          if iq.type == :set and iq.from == @peer_jid and iq.to == @my_jid and open and open.attributes['sid'] == @session_id
+            @stream.delete_iq_callback(self)
+            activate
+            @block_size = (open.attributes['block-size'] || 4096).to_i
+
+            reply = iq.answer(false)
+            reply.type = :result
+            @stream.send(reply)
+
+            connect_sem.run
+            true
+          else
+            false
+          end
+        }
+
+        @accept_ready.run
+
+        connect_sem.wait
+        true
+      end
+    end
+  end
+end

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

@@ -0,0 +1,153 @@
+# =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/
+
+require 'socket'
+require 'thread'
+require 'timeout'
+require 'digest/sha1'
+
+require 'xmpp4r/callbacks'
+require 'xmpp4r/bytestreams/helper/socks5bytestreams/socks5'
+
+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|
+          reply.query.each_element { |e|
+            if e.kind_of?(StreamHost)
+              e.jid = reply.from  # Help misconfigured proxys
+              res = e
+            end
+          }
+        }
+
+        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.hexdigest("#{@session_id}#{@initiator_jid}#{@target_jid}")
+      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