agent_xmpp 0.1.0

data/lib/agent_xmpp/xmpp/sasl.rb

@@ -0,0 +1,241 @@
+# Original from XMPP4R - XMPP Library for Ruby Website::http://home.gna.org/xmpp4r/
+##############################################################################################################
+module AgentXmpp
+
+  #####-------------------------------------------------------------------------------------------------------
+  module Xmpp
+
+    #####-------------------------------------------------------------------------------------------------------
+    module SASL
+
+      #.....................................................................................................
+      NS_SASL = 'urn:ietf:params:xml:ns:xmpp-sasl'
+
+      #####-------------------------------------------------------------------------------------------------------
+      class << self
+        
+        #.....................................................................................................
+        def new(mechanism)
+          case mechanism
+            when 'DIGEST-MD5'
+              DigestMD5.new
+            when 'PLAIN'
+              Plain.new
+            when 'ANONYMOUS'
+              Anonymous.new
+            else
+              raise AgentXmppError "Unknown SASL mechanism: #{mechanism}"
+          end
+        end
+      
+        #.........................................................................................................
+        def authenticate(stream_mechanisms)
+          if stream_mechanisms.include?('PLAIN')
+            Send(new('PLAIN').auth(AgentXmpp.jid, AgentXmpp.password))
+          else
+            raise AgentXmppError, "PLAIN authentication required"
+          end
+        end
+
+      #### self
+      end
+    
+      #####-------------------------------------------------------------------------------------------------------
+      class Base
+
+        #.....................................................................................................
+        def initialize
+        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
+      
+      #### Base
+      end
+
+      #####-------------------------------------------------------------------------------------------------------
+      class Plain < Base
+
+        #.....................................................................................................
+        def auth(jid, password)
+          auth_text = "#{jid.strip}\x00#{jid.node}\x00#{password}"
+          generate_auth('PLAIN', Base64::encode64(auth_text).gsub(/\s/, ''))
+        end
+
+      ### Plain
+      end
+
+      #####-------------------------------------------------------------------------------------------------------
+      class Anonymous < Base
+
+        #.....................................................................................................
+        def auth(password)
+          auth_text = "#{@stream.jid.node}"
+          error = nil
+          @stream.send(generate_auth('ANONYMOUS', Base64::encode64(auth_text).gsub(/\s/, ''))) do |reply|
+            error = reply.first_element(nil).name if reply.name != 'success'
+            true
+          end
+          raise error if error
+        end
+        
+      #### Anonymous
+      end
+
+      #####-------------------------------------------------------------------------------------------------------
+      class DigestMD5 < Base
+
+        #.....................................................................................................
+        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 == ','
+                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
+          res[key] = value unless key == ''
+
+          res
+        end
+
+        #.....................................................................................................
+        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, @stream.jid.domain, response['digest-uri'], password, @nonce, response['cnonce'], response['qop'], response['authzid'])
+          response.each do |key,value|
+            unless %w(nc qop response charset).include? key
+              response[key] = "\"#{value}\""
+            end
+          end
+
+          response_text = response.collect { |k,v| "#{k}=#{v}" }.join(',')
+          r = REXML::Element.new('response')
+          r.add_namespace NS_SASL
+          r.text = Base64::encode64(response_text).gsub(/\s/, '')
+
+          success_already = false
+          error = nil
+          @stream.send(r) do |reply|
+            if reply.name == 'success'
+              success_already = true
+            elsif reply.name != 'challenge'
+              error = reply.first_element(nil).name
+            end
+            true
+          end
+
+          return if success_already
+          raise error if error
+
+          r.text = nil
+          @stream.send(r) do |reply|
+            if reply.name != 'success'
+              error = reply.first_element(nil).name
+            end
+            true
+          end
+          raise error if error
+          
+        end
+
+        private
+
+        #.....................................................................................................
+        def h(s); Digest::MD5.digest(s); end
+
+        #.....................................................................................................
+        def hh(s); Digest::MD5.hexdigest(s); end
+
+        #.....................................................................................................
+        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
+      
+    #### DigestMD5 
+    end
+    
+  #### XMPP
+  end
+
+#### AgentXmpp
+end
+

data/lib/agent_xmpp/xmpp/stanza.rb

@@ -0,0 +1,107 @@
+# Original from XMPP4R - XMPP Library for Ruby Website::http://home.gna.org/xmpp4r/
+##############################################################################################################
+module AgentXmpp
+
+  #####-------------------------------------------------------------------------------------------------------
+  module Xmpp
+
+    #####-------------------------------------------------------------------------------------------------------
+    class IdGenerator
+
+      #.......................................................................................................
+      @last_id = 0
+
+      #.......................................................................................................
+      class << self
+
+        #.......................................................................................................
+        def generate_id
+          @last_id += 1
+          timefrac = Time.new.to_f.to_s.split(/\./, 2).last[-3..-1]
+          "#{@last_id}#{timefrac}"
+        end
+
+      #### self
+      end
+    
+    #### IdGenerator
+    end
+
+    #####-------------------------------------------------------------------------------------------------------
+    class Stanza < Element
+
+      #.......................................................................................................
+      def Stanza.answer(stanza, import=true)
+        x = stanza.class.new
+        if import
+          x.import(stanza)
+        end
+        x.from = stanza.to
+        x.to = stanza.from
+        x.id = stanza.id
+        x
+      end
+
+      #.......................................................................................................
+      def error
+        first_element('error')
+      end
+
+      #.......................................................................................................
+      def answer(import=true)
+        Stanza.answer(self, import)
+      end
+
+      #.......................................................................................................
+      def normalize
+      end
+
+      #.......................................................................................................
+      def to
+        (a = attribute('to')).nil? ? a : Jid.new(a.value)
+      end
+
+      #.......................................................................................................
+      def to=(v)
+        add_attribute('to', v ? v.to_s : nil)
+      end
+
+      #.......................................................................................................
+      def from
+        (a = attribute('from')).nil? ? a : Jid.new(a.value)
+      end
+
+      #.......................................................................................................
+      def from=(v)
+        add_attribute('from', v ? v.to_s : nil)
+      end
+
+      #.......................................................................................................
+      def id
+        (a = attribute('id')).nil? ? a : a.value
+      end
+
+      #.......................................................................................................
+      def id=(v)
+        add_attribute('id', v.to_s)
+      end
+
+      #.......................................................................................................
+      def type
+        stanza_type = attributes['type']
+        stanza_type.nil? ? nil : stanza_type.to_sym
+      end
+
+      #.......................................................................................................
+      def type=(t)
+        attributes['type'] = t.to_s
+      end
+
+    #### Stanza
+    end
+    
+  #### XMPP
+  end
+
+#### AgentXmpp
+end

data/lib/agent_xmpp/xmpp/x_data.rb

@@ -0,0 +1,357 @@
+# Original from XMPP4R - XMPP Library for Ruby Website::http://home.gna.org/xmpp4r/
+##############################################################################################################
+module AgentXmpp
+
+  #####-------------------------------------------------------------------------------------------------------
+  module Xmpp
+
+    #####-------------------------------------------------------------------------------------------------------
+    class X < Element
+      name_xmlns 'x'
+    end
+
+    #####-------------------------------------------------------------------------------------------------------
+    module XParent
+
+      #.......................................................................................................
+      def x(wanted_xmlns=nil)
+        if wanted_xmlns.kind_of? Class and wanted_xmlns.ancestors.include? Element
+          wanted_xmlns = wanted_xmlns.new.namespace
+        end
+        elements.to_a('x').select{|x| wanted_xmlns.nil? or wanted_xmlns == x.namespace}.first
+      end
+      
+    #### XParent
+    end
+
+    #####-------------------------------------------------------------------------------------------------------
+    class XData < X
+
+      #.....................................................................................................
+      name_xmlns 'x', 'jabber:x:data'
+
+      #.....................................................................................................
+      def initialize(type=nil)
+        super()
+        self.type = type
+      end
+
+      #.....................................................................................................
+      def fields
+        elements.to_a('field')
+      end
+
+      #.....................................................................................................
+      def items
+        elements.to_a('item')
+      end
+
+      #.....................................................................................................
+      def type
+        attributes['type'].to_sym
+      end
+
+      #.....................................................................................................
+      def type=(t)
+        attributes['type'] = t.to_s
+      end
+
+      #.....................................................................................................
+      def title
+        first_element('title')
+      end
+
+      #.....................................................................................................
+      def add_title(title)
+        delete_elements('title')
+        add_element(XDataTitle.new(title))
+      end
+
+      #.....................................................................................................
+      def instructions
+        elements.inject('instructions', []) {|f, xe| f << xe}
+      end
+
+      #.....................................................................................................
+      def add_instructions(i)
+        add(XDataInstructions.new(i))
+      end
+
+      #.....................................................................................................
+      def add_fixed(val=' ')
+        add_field_with_value(nil, val, 'fixed')
+      end
+
+      #.....................................................................................................
+      def add_hidden(var, val)
+        add_field_with_value(var, val, 'hidden')
+      end
+
+      #.....................................................................................................
+      def add_text_single(var, label=nil)
+        add_field(var, label, 'text-single')
+      end
+
+      #.....................................................................................................
+      def add_text_multi(var, label=nil)
+        add_field(var, label, 'text-multi')
+      end
+
+      #.....................................................................................................
+      def add_text_private(var, label=nil)
+        add_field(var, label, 'text-private')
+      end
+
+      #.....................................................................................................
+      def add_jid_single(var, label=nil)
+        add_field(var, label, 'jid-single')
+      end
+
+      #.....................................................................................................
+      def add_boolean(var, label=nil)
+        add_field(var, label, 'boolean')
+      end
+
+      #.....................................................................................................
+      def add_list_single(var, opts, label=nil, default=nil)
+        field = XDataField.new(var, 'list-single')
+        field.label = label if label
+        field.options = opts
+        field.values = [default] if default
+        self << field
+      end
+
+      #.....................................................................................................
+      def add_field_with_value(var, value, type=nil)
+        field = XDataField.new(var, type)
+        field.values = value
+        self << field
+      end
+
+      #.....................................................................................................
+      def to_native 
+        f, i = fields, items   
+        if f.length.eql?(1) and i.length.eql?(0)
+          to_scalar(f.first.values)
+        elsif f.length > 1 and i.length.eql?(0)  
+          to_hash(f)
+        elsif i.length > 0 
+           to_array_of_hashes(i)
+        else
+          nil
+        end
+      end
+
+      #.....................................................................................................
+      def to_params
+        to_hash(fields)
+      end
+      
+      #.....................................................................................................
+      def to_x_data
+        self
+      end
+
+      #.....................................................................................................
+      # private
+      #.....................................................................................................
+      def to_scalar(vals)
+        vals.length.eql?(1) ? vals.first : vals
+      end
+      
+      #.....................................................................................................
+      def to_hash(flds)
+        flds.inject({}) do |h,f| 
+          if handle_field_type?(f)
+            h[f.var] = to_scalar(get_field_values(f))
+          end; h
+        end
+      end
+
+      #.....................................................................................................
+      def to_array_of_hashes(itms)
+        itms.map{|i| to_hash(i.fields)}
+      end
+
+      #.....................................................................................................
+      def add_field(var, label, type=nil)
+        field = XDataField.new(var, type)
+        field.label = label if label
+        self << field
+      end
+      
+      #.....................................................................................................
+      def get_field_values(field)
+        vals = field.values
+        case field.type
+          when :boolean then vals.length.eql?(0) ? ['0'] : vals
+          when :"text-multi" then [vals.compact.join("/n")]
+        else vals
+        end
+      end
+
+      #.....................................................................................................
+      def handle_field_type?(field)
+        case field.type
+          when :fixed then false
+        else field
+        end
+          
+      end
+      
+      #.....................................................................................................
+      private :to_scalar, :to_hash, :to_array_of_hashes, :add_field, :get_field_values, 
+              :handle_field_type?
+      
+    end
+
+    #####-------------------------------------------------------------------------------------------------------
+    class XDataTitle < Element
+
+      #.....................................................................................................
+      name_xmlns 'title', 'jabber:x:data'
+
+      #.....................................................................................................
+      def initialize(title=nil)
+        super()
+        add_text(title)
+      end
+
+      #.....................................................................................................
+      def to_s
+        text.to_s
+      end
+
+      #.....................................................................................................
+      def title
+        text
+      end
+      
+    end
+
+    #####-------------------------------------------------------------------------------------------------------
+    class XDataInstructions < Element
+
+      #.....................................................................................................
+      name_xmlns 'instructions', 'jabber:x:data'
+
+      #.....................................................................................................
+      def initialize(instructions=nil)
+        super()
+        add_text(instructions)
+      end
+
+      #.....................................................................................................
+      def to_s
+        text.to_s
+      end
+
+      #.....................................................................................................
+      def instructions
+        text
+      end
+    end
+
+    #####-------------------------------------------------------------------------------------------------------
+    class XDataField < Element
+
+      #.....................................................................................................
+      name_xmlns 'field', 'jabber:x:data'
+      xmpp_attribute :label, :var
+      xmpp_attribute :type, :sym => true
+
+      #.....................................................................................................
+      def initialize(var=nil, type=nil)
+        super()
+        self.var = var if var
+        self.type = type if type
+      end
+
+      #.....................................................................................................
+      def required?
+        res = false
+        each_element('required') { res = true }
+        res
+      end
+
+      #.....................................................................................................
+      def required=(r)
+        delete_elements('required')
+        add REXML::Element.new('required') if r
+      end
+
+      #.....................................................................................................
+      def values
+        elements.inject('value', []){|r,v| r << v.text}
+      end
+
+      #.....................................................................................................
+      def values=(ary)
+        delete_elements('value')
+        [ary].flatten.each {|v| add(REXML::Element.new('value')).text = v}
+      end
+
+      #.....................................................................................................
+      def options
+        elements.inject('option',{}) do |r, e|
+          value = nil
+          value = (ve = first_element('value')).nil? ? nil : ve.text
+          r[value] = e.attributes['label'] if value; r 
+        end
+      end
+
+      #.....................................................................................................
+      def options=(opts)
+        opts = opts.inject({}){|h,v| h.update(v => v.to_s.gsub(/_/,' '))} if opts.kind_of?(Array)
+        delete_elements('option')
+        opts.each do |value,label|
+          o = add(REXML::Element.new('option'))
+          o.attributes['label'] = label
+          o.add(REXML::Element.new('value')).text = value.to_s
+        end
+      end
+    end
+
+    #####-------------------------------------------------------------------------------------------------------
+    class XDataReported < Element
+
+      #.....................................................................................................
+      name_xmlns 'reported', 'jabber:x:data'
+
+      #.....................................................................................................
+      def fields
+        elements.to_a('field')
+      end
+
+      #.....................................................................................................
+      def add_field(var)
+        self << XDataField.new(var)
+      end
+    end
+
+    #####-------------------------------------------------------------------------------------------------------
+    class XDataItem < Element
+
+      #.....................................................................................................
+      name_xmlns 'item', 'jabber:x:data'
+
+      #.....................................................................................................
+      def fields
+        elements.to_a('field')
+      end
+
+      #.....................................................................................................
+      def add_field_with_value(var, value, type=nil)
+        field = XDataField.new(var, type)        
+        field.values = value
+        self << field
+      end
+
+    #### XDataItem
+    end 
+
+  #### XMPP
+  end
+
+#### AgentXmpp
+end