gmcmillan-xmpp4r 0.5

data/lib/xmpp4r/rpc/helper/server.rb

@@ -0,0 +1,74 @@
+require 'xmlrpc/server'
+require 'xmlrpc/parser'
+require 'xmlrpc/create'
+require 'xmlrpc/config'
+require 'xmlrpc/utils'         # ParserWriterChooseMixin
+
+require 'xmpp4r/dataforms/x/data'
+require 'xmpp4r/rpc/iq/rpc'
+require 'xmpp4r/rpc/helper/xmlrpcaddons'
+
+module Jabber
+  module RPC
+
+    ##
+    # XMLRPC Server
+    class Server < XMLRPC::BasicServer
+
+      include XMLRPC::ParserWriterChooseMixin
+      include XMLRPC::ParseContentType
+
+      ##
+      # new - creates a new server
+      #
+      def initialize(stream,class_delim=".")
+        super(class_delim)
+        @stream = stream
+        @stream.add_iq_callback(120,"Helpers::RPCServer") { |iq|
+          if iq.type == :set and iq.type != :result
+            handle_iq(iq)
+            true
+          else
+            false
+          end
+        }
+      end
+
+      ##
+      # handles incoming iqs
+      # iq:: [Jabber::IQ] - the jabber iq
+      def handle_iq(iq)
+        if iq.type == :set
+          if iq.query.kind_of?(IqQueryRPC)
+            data = iq.query
+            response = IqQueryRPC.new
+            data.elements.each { |rpc|
+              if rpc
+                response.typed_add(handle_rpc_requests(rpc))
+              end
+            }
+
+            respiq = iq.answer(false)
+            respiq.type = :result
+            respiq.add(response)
+            @stream.send(respiq)
+          end
+        end
+      end
+
+      private
+
+      ##
+      # handles the rpc requests
+      # takes rpcdata:: [String]
+      def handle_rpc_requests(rpcdata)
+        resp = process(rpcdata.to_s)
+        if resp == nil or resp.size <= 0
+          raise Jabber::ErrorResponse.new(:forbidden)
+        else
+          return resp
+        end
+      end
+    end # RPCServer
+  end  # Helpers
+end   # Jabber

data/lib/xmpp4r/rpc/helper/xmlrpcaddons.rb

@@ -0,0 +1,67 @@
+require "xmlrpc/parser"
+require "xmlrpc/create"
+require "xmlrpc/config"
+require "xmlrpc/utils"     # ParserWriterChooseMixin
+
+
+module XMLRPC
+  class Create
+
+    # Avoids warnings
+    remove_method(:methodCall)
+    remove_method(:methodResponse)
+
+    ##
+    # create a Method Call
+    # name:: [String] name of the method
+    # params:: [Array] params of the method as a array
+    def methodCall(name, *params)
+      name = name.to_s
+
+      if name !~ /[a-zA-Z0-9_.:\/]+/
+        raise ArgumentError, "Wrong XML-RPC method-name"
+      end
+
+      parameter = params.collect { |param|
+        @writer.ele("param", conv2value(param))
+      }
+
+      tree = @writer.document(
+               @writer.ele("methodCall",
+                 @writer.tag("methodName", name),
+                 @writer.ele("params", *parameter)
+               )
+             )
+
+      @writer.document_to_str(tree) + "\n"
+    end
+    ##
+    # create a response to a method call
+    # is_ret:: [TrueClass] is this a return (true)  or a error (false)
+    # params:: [Array] a array of params
+
+    def methodResponse(is_ret, *params)
+
+      if is_ret
+        begin
+          resp = params.collect do |param|
+            @writer.ele("param", conv2value(param))
+          end
+
+          resp = [@writer.ele("params", *resp)]
+        rescue Exception => e
+          error = XMLRPC::FaultException.new(XMLRPC::BasicServer::ERR_UNCAUGHT_EXCEPTION, "Uncaught exception '#{e.message}' serialising params into response")
+          resp = @writer.ele("fault", conv2value(error.to_h))
+        end
+      else
+        if params.size != 1 or params[0] === XMLRPC::FaultException
+          raise ArgumentError, "no valid fault-structure given"
+        end
+        resp = @writer.ele("fault", conv2value(params[0].to_h))
+      end
+
+      tree = @writer.document(@writer.ele("methodResponse", resp))
+      @writer.document_to_str(tree) + "\n"
+    end
+  end
+end

data/lib/xmpp4r/rpc/iq/rpc.rb

@@ -0,0 +1,23 @@
+# =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/query'
+
+module Jabber
+  module RPC
+    class IqQueryRPC < IqQuery
+      NS_RPC = 'jabber:iq:rpc'
+      name_xmlns 'query', NS_RPC
+
+      # TODO: Is typed_add with a String right here?
+      def typed_add(e)
+        if e.kind_of? String
+          typed_add(REXML::Document.new(e).root)
+        else
+          super
+        end
+      end
+    end
+  end
+end

data/lib/xmpp4r/sasl.rb

@@ -0,0 +1,259 @@
+# =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 'digest/md5'
+require 'xmpp4r/base64'
+
+module Jabber
+  ##
+  # Helpers for SASL authentication (RFC2222)
+  #
+  # You might not need to use them directly, they are
+  # invoked by Jabber::Client#auth
+  module SASL
+    NS_SASL = 'urn:ietf:params:xml:ns:xmpp-sasl'
+
+    ##
+    # Factory function to obtain a SASL helper for the specified mechanism
+    def SASL.new(stream, mechanism)
+      case mechanism
+        when 'DIGEST-MD5'
+          DigestMD5.new(stream)
+        when 'PLAIN'
+          Plain.new(stream)
+        when 'ANONYMOUS'
+          Anonymous.new(stream)
+        else
+          raise "Unknown SASL mechanism: #{mechanism}"
+      end
+    end
+
+    ##
+    # SASL mechanism base class (stub)
+    class Base
+      def initialize(stream)
+        @stream = stream
+      end
+
+      private
+
+      def generate_auth(mechanism, text=nil)
+        auth = REXML::Element.new 'auth'
+        auth.add_namespace NS_SASL
+        auth.attributes['mechanism'] = mechanism
+        auth.text = text
+        auth
+      end
+
+      def generate_nonce
+        Digest::MD5.hexdigest(Time.new.to_f.to_s)
+      end
+    end
+
+    ##
+    # SASL PLAIN authentication helper (RFC2595)
+    class Plain < Base
+      ##
+      # Authenticate via sending password in clear-text
+      def auth(password)
+        auth_text = "#{@stream.jid.strip}\x00#{@stream.jid.node}\x00#{password}"
+        error = nil
+        @stream.send(generate_auth('PLAIN', Base64::encode64(auth_text).gsub(/\s/, ''))) { |reply|
+          if reply.name != 'success'
+            error = reply.first_element(nil).name
+          end
+          true
+        }
+
+        raise error if error
+      end
+    end
+
+    ##
+    # SASL Anonymous authentication helper
+    class Anonymous < Base
+      ##
+      # Authenticate by sending nothing with the ANONYMOUS token
+      def auth(password)
+        auth_text = "#{@stream.jid.node}"
+        error = nil
+        @stream.send(generate_auth('ANONYMOUS', Base64::encode64(auth_text).gsub(/\s/, ''))) { |reply|
+          if reply.name != 'success'
+            error = reply.first_element(nil).name
+          end
+          true
+        }
+
+        raise error if error
+      end
+    end
+
+    ##
+    # SASL DIGEST-MD5 authentication helper (RFC2831)
+    class DigestMD5 < Base
+      ##
+      # Sends the wished auth mechanism and wait for a challenge
+      #
+      # (proceed with DigestMD5#auth)
+      def initialize(stream)
+        super
+
+        challenge = {}
+        error = nil
+        @stream.send(generate_auth('DIGEST-MD5')) { |reply|
+          if reply.name == 'challenge' and reply.namespace == NS_SASL
+            challenge = decode_challenge(reply.text)
+          else
+            error = reply.first_element(nil).name
+          end
+          true
+        }
+        raise error if error
+
+        @nonce = challenge['nonce']
+        @realm = challenge['realm']
+      end
+
+      def decode_challenge(challenge)
+        text = Base64::decode64(challenge)
+        res = {}
+
+        state = :key
+        key = ''
+        value = ''
+        text.scan(/./) do |ch|
+          if state == :key
+            if ch == '='
+              state = :value
+            else
+              key += ch
+            end
+
+          elsif state == :value
+            if ch == ','
+              # due to our home-made parsing of the challenge, the key could have
+              # leading whitespace. strip it, or that would break jabberd2 support.
+              key = key.strip
+              res[key] = value
+              key = ''
+              value = ''
+              state = :key
+            elsif ch == '"' and value == ''
+              state = :quote
+            else
+              value += ch
+            end
+
+          elsif state == :quote
+            if ch == '"'
+              state = :value
+            else
+              value += ch
+            end
+          end
+        end
+        # due to our home-made parsing of the challenge, the key could have
+        # leading whitespace. strip it, or that would break jabberd2 support.
+        key = key.strip
+        res[key] = value unless key == ''
+
+        Jabber::debuglog("SASL DIGEST-MD5 challenge:\n#{text}\n#{res.inspect}")
+
+        res
+      end
+
+      ##
+      # * Send a response
+      # * Wait for the server's challenge (which aren't checked)
+      # * Send a blind response to the server's challenge
+      def auth(password)
+        response = {}
+        response['nonce'] = @nonce
+        response['charset'] = 'utf-8'
+        response['username'] = @stream.jid.node
+        response['realm'] = @realm || @stream.jid.domain
+        response['cnonce'] = generate_nonce
+        response['nc'] = '00000001'
+        response['qop'] = 'auth'
+        response['digest-uri'] = "xmpp/#{@stream.jid.domain}"
+        response['response'] = response_value(@stream.jid.node, response['realm'], response['digest-uri'], password, @nonce, response['cnonce'], response['qop'], response['authzid'])
+        response.each { |key,value|
+          unless %w(nc qop response charset).include? key
+            response[key] = "\"#{value}\""
+          end
+        }
+
+        response_text = response.collect { |k,v| "#{k}=#{v}" }.join(',')
+        Jabber::debuglog("SASL DIGEST-MD5 response:\n#{response_text}\n#{response.inspect}")
+
+        r = REXML::Element.new('response')
+        r.add_namespace NS_SASL
+        r.text = Base64::encode64(response_text).gsub(/\s/, '')
+
+        success_already = false
+        error = nil
+        # This send hangs sometimes waiting in Stream#send on threadblock.wait (with Openfire 3.6.4 at least);
+        #  since the calback here is pretty simple, that likely means it never receives a response stanza
+        #  therefore we should put in a timeout on send, and do some retries here (okay since its the first message)
+        # TODO Verify if 1 second timeout, and 3 tries are good settings
+        # TODO Add test/spec when/if they are created
+        tries = 3
+        begin
+          @stream.send(r, 1) { |reply|
+            if reply.name == 'success'
+              success_already = true
+            elsif reply.name != 'challenge'
+              error = reply.first_element(nil).name
+            end
+            true
+          }
+        rescue Timeout::Error
+          retry if (tries -= 1) > 0
+          # TODO create a SASL::AuthError to handle this and other direct raise calls
+          raise "Failed to send SASL::DigestMD5 response"
+        end
+
+        return if success_already
+        raise error if error
+
+        # TODO: check the challenge from the server
+
+        r.text = nil
+        @stream.send(r) { |reply|
+          if reply.name != 'success'
+            error = reply.first_element(nil).name
+          end
+          true
+        }
+
+        raise error if error
+      end
+
+      private
+
+      ##
+      # Function from RFC2831
+      def h(s); Digest::MD5.digest(s); end
+      ##
+      # Function from RFC2831
+      def hh(s); Digest::MD5.hexdigest(s); end
+
+      ##
+      # Calculate the value for the response field
+      def response_value(username, realm, digest_uri, passwd, nonce, cnonce, qop, authzid)
+        a1_h = h("#{username}:#{realm}:#{passwd}")
+        a1 = "#{a1_h}:#{nonce}:#{cnonce}"
+        if authzid
+          a1 += ":#{authzid}"
+        end
+        if qop == 'auth-int' || qop == 'auth-conf'
+          a2 = "AUTHENTICATE:#{digest_uri}:00000000000000000000000000000000"
+        else
+          a2 = "AUTHENTICATE:#{digest_uri}"
+        end
+        hh("#{hh(a1)}:#{nonce}:00000001:#{cnonce}:#{qop}:#{hh(a2)}")
+      end
+    end
+  end
+end

data/lib/xmpp4r/semaphore.rb

@@ -0,0 +1,38 @@
+# =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
+  ##
+  # This class implements semaphore for threads synchronization.
+  class Semaphore
+
+    ##
+    # Initialize new semaphore
+    #
+    # val:: [Integer] number of threads, that can enter to section
+    def initialize(val=0)
+      @tickets = val
+      @lock = Mutex.new
+      @cond = ConditionVariable.new
+    end
+
+    ##
+    # Waits until are available some free tickets
+    def wait
+      @lock.synchronize {
+        @cond.wait(@lock) while !(@tickets > 0)
+        @tickets -= 1
+      }
+    end
+
+    ##
+    # Unlocks guarded section, increments number of free tickets
+    def run
+      @lock.synchronize {
+        @tickets += 1
+        @cond.signal
+      }
+    end
+  end
+end