cul-handles 0.1.0 → 0.2.0

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/cul-handles.gemspec

@@ -0,0 +1,79 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{cul-handles}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["James Stuart"]
+  s.date = %q{2009-11-11}
+  s.description = %q{Columbia client to deal with handle server}
+  s.email = %q{tastyhat@jamesstuart.org}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "cul-handles.gemspec",
+     "lib/cul-handles.rb",
+     "lib/cul/handles/base_message.rb",
+     "lib/cul/handles/base_request.rb",
+     "lib/cul/handles/base_response.rb",
+     "lib/cul/handles/challenge_answer_request.rb",
+     "lib/cul/handles/challenge_response.rb",
+     "lib/cul/handles/client.rb",
+     "lib/cul/handles/create_handle_request.rb",
+     "lib/cul/handles/delete_handle_request.rb",
+     "lib/cul/handles/delete_value_request.rb",
+     "lib/cul/handles/handle_value_request.rb",
+     "lib/cul/handles/hdl.rb",
+     "lib/cul/handles/modify_value_request.rb",
+     "lib/cul/handles/resolution_request.rb",
+     "lib/cul/handles/resolution_response.rb",
+     "lib/cul/handles/session_request.rb",
+     "lib/cul/handles/session_setup_response.rb",
+     "lib/cul/handles/set_value_request.rb",
+     "test/authn_test.rb",
+     "test/cul-handles_test.rb",
+     "test/dh_test.rb",
+     "test/resolution_test.rb",
+     "test/test_helper.rb",
+     "test/unsigned_integer_test.rb"
+  ]
+  s.homepage = %q{http://github.com/tastyhat/cul-handles}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{CUL Handle Client}
+  s.test_files = [
+    "test/authn_test.rb",
+     "test/cul-handles_test.rb",
+     "test/dh_test.rb",
+     "test/resolution_test.rb",
+     "test/test_helper.rb",
+     "test/unsigned_integer_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
+end
+

data/lib/cul/handles/base_message.rb

@@ -0,0 +1,121 @@
+module Cul
+  module Handles
+    class BaseMessage
+      include Hdl
+      def initialize
+        @SHA1 = Digest::SHA1.new()
+        @MD5 = Digest::MD5.new()
+        @digest = [nil,@MD5,@SHA1]
+        @majorVersion = 2 # default
+        @minorVersion = 1 # default
+        @digestAlg = 2 # SHA1 = 2, MD5 = 1
+        @digestLength = 20 # SHA1 = 20 octets, MD5 = 16
+        @sequenceNumber = [0,0,0,0]
+
+      end
+  
+      def authoritative=(val)
+        if(val)
+          @opFlag[MSG_FLAG_AUTH_INDEX] |= MSG_FLAG_AUTH
+        else
+          @opFlag[MSG_FLAG_AUTH_INDEX] &= ~MSG_FLAG_AUTH
+        end
+      end
+      def authoritative()
+        return @opFlag[MSG_FLAG_AUTH_INDEX] & MSG_FLAG_AUTH > 0
+      end
+      def certify=(val)
+        if(val)
+          @opFlag[MSG_FLAG_CERT_INDEX] |= MSG_FLAG_CERT
+        else
+        @opFlag[MSG_FLAG_CERT_INDEX] &= ~MSG_FLAG_CERT
+        end
+      end
+      def certify()
+        return @opFlag[MSG_FLAG_CERT_INDEX] & MSG_FLAG_CERT > 0
+      end
+      def encrypt=(val)
+        if(val)
+          @opFlag[MSG_FLAG_ENCR_INDEX] |= MSG_FLAG_ENCR
+        else
+          @opFlag[MSG_FLAG_ENCR_INDEX] &= ~MSG_FLAG_ENCR
+        end
+      end
+      def encrypt()
+        return @opFlag[MSG_FLAG_ENCR_INDEX] & MSG_FLAG_ENCR > 0
+      end
+      def recursive=(val)
+        if(val)
+          @opFlag[MSG_FLAG_RECU_INDEX] |= MSG_FLAG_RECU
+        else
+          @opFlag[MSG_FLAG_RECU_INDEX] &= ~MSG_FLAG_RECU
+        end
+      end
+      def recursive()
+        return @opFlag[MSG_FLAG_RECU_INDEX] & MSG_FLAG_RECU > 0
+      end
+      def cacheCertify=(val)
+        if(val)
+          @opFlag[MSG_FLAG_CACR_INDEX] |= MSG_FLAG_CACR
+        else
+          @opFlag[MSG_FLAG_CACR_INDEX] &= ~MSG_FLAG_CACR
+        end
+      end
+      def cacheCertify()
+        return @opFlag[MSG_FLAG_CACR_INDEX] & MSG_FLAG_CACR > 0
+      end
+      def continuous=(val)
+        if(val)
+          @opFlag[MSG_FLAG_CONT_INDEX] |= MSG_FLAG_CONT
+        else
+        @opFlag[MSG_FLAG_CONT_INDEX] &= ~MSG_FLAG_CONT
+        end
+      end
+      def continuous()
+        return @opFlag[MSG_FLAG_CONT_INDEX] & MSG_FLAG_CONT > 0
+      end
+      def keepAlive=(val)
+        if(val)
+          @opFlag[MSG_FLAG_KPAL_INDEX] |= MSG_FLAG_KPAL
+        else
+          @opFlag[MSG_FLAG_KPAL_INDEX] &= ~MSG_FLAG_KPAL
+        end
+      end
+      def keepAlive()
+        return @opFlag[MSG_FLAG_KPAL_INDEX] & MSG_FLAG_KPAL > 0
+      end
+      def publicOnly=(val)
+        if(val)
+          @opFlag[MSG_FLAG_PUBL_INDEX] |= MSG_FLAG_PUBL
+        else
+        @opFlag[MSG_FLAG_PUBL_INDEX] &= ~MSG_FLAG_PUBL
+        end
+      end
+      def publicOnly()
+        return @opFlag[MSG_FLAG_PUBL_INDEX] & MSG_FLAG_PUBL > 0
+      end
+      def returnRequestDigest=(val)
+        if(val)
+          @opFlag[MSG_FLAG_RRDG_INDEX] |= MSG_FLAG_RRDG
+        else
+          @opFlag[MSG_FLAG_RRDG_INDEX] &= ~MSG_FLAG_RRDG
+        end
+      end
+      def returnRequestDigest()
+        return @opFlag[MSG_FLAG_RRDG_INDEX] & MSG_FLAG_RRDG > 0
+      end
+      def digestAlg=(val)
+        if(val == 1)
+          @digest = @MD5
+          @digestLength = 16
+        elsif(val == 2)
+          @digest = @SHA1
+          @digestLength = 20
+        else
+          @digest = nil      
+          @digestLength = 0
+        end
+      end
+    end
+  end
+end

data/lib/cul/handles/base_request.rb

@@ -0,0 +1,153 @@
+module Cul
+  module Handles
+    class BaseRequest < BaseMessage
+      def initialize()
+        super()
+        @body = []
+        @opFlag = [0,0,0,0]
+        @recursionCount = [0]
+        @messageFlag = [0,0]
+        @messageLength = [0,0,0,0]    
+        @siteInfoSerial = [0xff,0xff]
+        @sessionId = [0,0,0,0]
+        @credential = [0,0,0,0]
+      end
+      def valid?()
+        return true
+      end
+      def opCode=(val)
+        @opCode=asBytes(val)
+      end
+      def opCode()
+        @opCode
+      end
+      def opFlag=(val)
+        @opFlag=asBytes(val)
+      end
+      def opFlag()
+        fromBytes(@opFlag)
+      end
+      def requestId=(val)
+        @requestId=asBytes(val)
+      end
+      def requestId()
+        fromBytes(@requestId)
+      end
+      def sessionId=(val)
+        @sessionId=asBytes(val)
+      end
+      def sessionId()
+        @sessionId
+      end
+      def siteInfoSerial=(val)
+        if val < 0
+          @siteInfoSerial=asBytes(65536 + val)[-2..-1]
+        else
+          @siteInfoSerial = asBytes(val)[-2..-1]
+        end
+      end
+      def siteInfoSerial()
+        return fromBytes(@siteInfoSerial)
+      end
+      def sequenceNumber()
+        fromBytes(@sequenceNumber)
+      end
+      def sequenceNumber=(val)
+        @sequenceNumber=asBytes(val)
+      end
+      def recursionCount()
+        fromBytes(@recursionCount)
+      end
+      def recursionCount=(val)
+        @recursionCount=asBytes(val)
+      end
+      def expirationTime()
+        fromBytes(@expirationTime)
+      end
+      def expirationTime=(val)
+        @expirationTime=asBytes(val)
+      end
+      def responseCode=(val)
+        @responseCode=asBytes(val)
+      end
+      def responseCode
+        @responseCode
+      end
+      def credentialVersion()
+        return []
+      end
+      def credentialReserved()
+        return []
+      end
+      def credentialOptions()
+        return []
+      end
+      def credentialSigner()
+        return []
+      end
+      def credentialType()
+        return []
+      end
+      def credentialDigestAlg()
+        return []
+      end
+      def encodeCredential()
+        creds = [].concat(self.credentialVersion).concat(self.credentialReserved).concat(self.credentialOptions()).concat(self.credentialSigner).concat(self.credentialType)
+        creds = asBytes(creds.length).concat(creds)
+        @credential = creds
+      end
+      def credential()
+        @credential
+      end
+      def messageFlag=(val)
+        @messageFlag = val
+      end
+      def envelope
+        e = [@majorVersion, @minorVersion]
+        e.concat(@messageFlag)
+        e.concat(@sessionId)
+        e.concat(@requestId)
+        e.concat(@sequenceNumber)
+        e.concat(asBytes(@body.length + 24 + @credential.length))
+        e
+      end
+      def messageFlag
+        return @messageFlag
+      end
+      def messageLength
+        @body.length + 24 + @credential.length
+      end
+      def header
+        result = [].concat(self.opCode)
+        result.concat(@responseCode)
+        result.concat(@opFlag)
+        result.concat(@siteInfoSerial)
+        result.concat(@recursionCount)
+        result.concat([0])
+        result.concat(@expirationTime)
+        result.concat(asBytes(@body.length))
+        return result
+      end
+      def body
+        return @body
+      end
+      def encodeBody()
+        return
+      end
+      def bodyLength
+        return asBytes(@body.length) 
+      end
+      def digest(data)
+        return @SHA1.digest(data.pack('U*')).unpack('c*')
+      end
+      def packet
+        encodeBody()
+        encodeCredential()
+        result =  envelope().concat(header())
+        result.concat(body())
+        result.concat(credential())
+        return result
+      end
+    end
+  end
+end

data/lib/cul/handles/base_response.rb

@@ -0,0 +1,191 @@
+module Cul
+  module Handles
+
+    class BaseResponse < BaseMessage
+      include Hdl
+      def initialize
+        super()
+        @packet = []
+        @siteInfoSerial = [0,0]
+        @requestId = [0,0,0,0]
+        @sessionId = [0,0,0,0]
+        @opCode = [0,0,0,0]
+        @responseCode = [0,0,0,0]
+        @opFlag = [0,0,0,0]
+        @recursionCount = 0
+        @expirationTime = [0,0,0,0]
+        @bodyLength = 0
+        @debug = false
+      end
+      def debug=(val)
+        if(val)
+          @debug = true
+        else
+          @debug = false
+        end
+      end
+      def send(req,sock)
+        if not req.valid?()
+          raise "Request invalid: " + req.to_s
+        end
+        initialize()
+        bytes = req.packet
+        bctr = 0
+        puts "sending \n" + bytes.collect{|byte|
+           bctr = bctr + 1
+          if byte.nil?
+            "nil byte at " + bctr.to_s
+          else
+          "%02x" % byte
+          end
+        }.join if @debug
+        sent = sock.write(bytes.pack('C*'))
+    
+        if sent != bytes.length
+          puts "Warning: Attempted to send " + bytes.length.to_s + "; actually sent " + sent.to_s
+        end
+        parseEnvelope(sock.recv(20).unpack('C*'))
+        puts "parsed envelope" if @debug
+        parseHeader(sock.recv(24).unpack('C*'))
+        puts "parsed header" if @debug
+        parseBody(sock.recv(@bodyLength).unpack('C*'))
+        puts "parsed body" if @debug
+        parseCredential(Array.new())
+      end
+      def parseEnvelope(data)
+        "parseEnvelope"
+        if(data.length != 20)
+          puts("Unexpected envelope length: " + data.length.to_s)
+          return
+        end
+        @packet.concat(data)
+        # version info
+        @majorVersion = data[0]
+        @minorVersion = data[1]
+        # message flag
+        mflag = data[2] # actually 2 octets, but second octet is reserved
+        if ((mflag & Hdl::ENV_FLAG_COMPRESSED) == Hdl::ENV_FLAG_COMPRESSED)
+          @compressed = true
+        end
+        if ((mflag & Hdl::ENV_FLAG_ENCRYPTED) == Hdl::ENV_FLAG_ENCRYPTED)
+          @encrypted = true
+        end
+        if ((mflag & Hdl::ENV_FLAG_TRUNCATED) == Hdl::ENV_FLAG_TRUNCATED)
+          @truncated = true
+        end
+        # session id
+        @sessionId = data[4..7]
+        # request id
+        @requestId = data[8..11]
+        # sequence number
+        @sequenceNumber = data[12..15]
+        # message length
+        @messageLength = data[16..19]
+      end
+      def sessionId
+        return fromBytes(@sessionId)
+      end
+      def requestId
+        return fromBytes(@requestId)
+      end
+      def parseHeader(data)
+        @packet.concat(data)
+        if(data.length != 24)
+          puts("Unexpected header length: " + data.length.to_s)
+          return
+        end
+        @opCode = data[0..3]
+        @responseCode = data[4..7]
+        @opFlag = data[8..11]
+        @siteInfoSerial = data[12..13]
+        @recursionCount = data[14]
+        @expirationTime = data[16..19]
+        @bodyLength = fromBytes(data[20..23])
+        if(@bodyLength < 1)
+          puts "Unexpected @bodyLength: " + @bodyLength.to_s
+        end
+      end
+      def opCode
+        return fromBytes(@opCode)
+      end
+      def responseCode
+        return fromBytes(@responseCode)
+      end
+      def success?
+        return @responseCode.eql?([0,0,0,1])
+      end
+      def siteInfoSerial
+        return fromBytes(@siteInfoSerial)
+      end
+      def parseBody(data)
+        offset = 0
+        @packet.concat(data)
+        # parse return digest
+        if self.returnRequestDigest()
+          self.digestAlg = data[offset]
+          if (@digestLength)
+            @messageDigest = data[1..(@digestLength)]
+            offset = 1 + @digestLength
+          else
+            @messageDigest = []
+          end
+        end
+        @body = data[offset...@bodyLength]
+      end
+      def body
+        @body
+      end
+      def parseCredential(data)
+        offset = 0
+        @packet.concat(data)
+        # parse credential
+        if (data.length > 0)
+          @credentialVersion = data[offset]
+          offset = offset + 2
+          @credentialOptions = data[offset..offset+1]
+          offset = offset + 2
+          @credential = data[offset...(offset+credentialLength)]
+          offset = offset + credentialLength
+          pstringData = readProtocolString(data,offset)
+          offset = offset + pstringData[0]
+          type = pstringData[1]
+          signedInfoLength = fromBytes(data[offset...offset+4])
+          offset = offset + 4
+          signedInfoAlg = nil
+          signedInfoData = nil
+          if signedInfoLength > 0
+            signedInfoEnd = offset + signedInfoLength
+            pstringData = readProtocolString(data,offset)
+            offset = offset + pstringData[0]
+            self.signedInfoAlg = pstringData[1]
+            self.signedInfoData = data[offset..-1]
+            offset = signedInfoEnd
+          end
+      
+        end
+      end
+      def credential
+        @credential
+      end
+      def credentialType=(val)
+        @credentialType = val
+      end
+      def signedInfoAlg=(val)
+        @signedInfoAlg = val
+      end
+      def signedInfo=(val)
+        @signedInfo=val
+      end
+      def packet
+        @packet
+      end
+      def to_s
+        result = "opCode: " + opCode.to_s + "; responseCode: " + responseCode().to_s + " sessionId: " + fromBytes(@sessionId).to_s + "; requestId: " + fromBytes(@requestId).to_s + "; bodyLength: " + @bodyLength.to_s
+        if @bodyLength > 0
+          result = result + "; body: " + @packet[44...(44+@bodyLength)].pack('c*')
+        end
+        result
+      end
+    end
+  end
+end

data/lib/cul/handles/challenge_answer_request.rb

@@ -0,0 +1,46 @@
+module Cul
+  module Handles
+    class ChallengeAnswerRequest < BaseRequest
+      include Hdl
+      def initialize(nonce,digest,keyHandle, keyIndex)
+        super()
+        @nonce = nonce
+        @digest =digest
+        @opCode = asBytes(OC_CHALLENGE_RESPONSE)
+        @authenticationType = toProtocolString("HS_SECKEY")
+        @keyHandle = toProtocolString(keyHandle)
+        @keyIndex = asBytes(keyIndex)
+        @challengeResponse = []
+        @secret = []
+        self.responseCode = 0
+        self.authoritative=false
+        self.returnRequestDigest=false
+        self.encrypt=false
+        self.publicOnly=false
+        self.certify=false
+        self.cacheCertify=true
+        self.recursive=true
+        self.continuous=false
+        self.keepAlive=false
+        self.expirationTime=0
+      end
+      def body()
+        @body
+      end
+      def secret=(val)
+        @secret = val.unpack('U*').pack('C*')
+      end
+      def encodeBody()
+        digest = Digest::SHA1.new()
+        digest.update(@secret)
+        digest.update(@nonce.pack('C*'))
+        digest.update(@digest.pack('C*'))
+        digest.update(@secret)
+        prehash = digest.digest()
+        @challengeResponse = [0x02].concat(prehash.unpack('C*'))
+        @challengeResponse = asBytes(@challengeResponse.length).concat(@challengeResponse)
+        @body = [].concat(@authenticationType).concat(@keyHandle).concat(@keyIndex).concat(@challengeResponse)
+      end  
+    end
+  end
+end

data/lib/cul/handles/challenge_response.rb

@@ -0,0 +1,23 @@
+module Cul
+  module Handles
+    class ChallengeResponse < BaseResponse
+      attr_reader :nonce, :digest
+      def parseBody(data)
+        # read digest
+        digestAlg = data[0]
+        if (digestAlg == 1)
+          @digest = data[1..16]
+          offset = 17
+        else
+          @digest = data[1..20]
+          offset = 21
+        end
+        arrayInfo = readByteArray(data,offset)
+        @nonce = arrayInfo[1]
+      end
+      def nonce
+        @nonce
+      end
+    end
+  end
+end