Class: Cul::Handles::BaseResponse

Inherits:
BaseMessage show all
Includes:
Hdl
Defined in:
lib/cul/handles/base_response.rb

Constant Summary

Constants included from Hdl

Hdl::ENV_FLAG_COMPRESSED, Hdl::ENV_FLAG_ENCRYPTED, Hdl::ENV_FLAG_TRUNCATED, Hdl::INDEX_ADMIN_HANDLE, Hdl::INDEX_AUTH, Hdl::INDEX_MAINTAINER_HANDLE, Hdl::MSG_FLAG_AUTH, Hdl::MSG_FLAG_AUTH_INDEX, Hdl::MSG_FLAG_CACR, Hdl::MSG_FLAG_CACR_INDEX, Hdl::MSG_FLAG_CERT, Hdl::MSG_FLAG_CERT_INDEX, Hdl::MSG_FLAG_CONT, Hdl::MSG_FLAG_CONT_INDEX, Hdl::MSG_FLAG_ENCR, Hdl::MSG_FLAG_ENCR_INDEX, Hdl::MSG_FLAG_KPAL, Hdl::MSG_FLAG_KPAL_INDEX, Hdl::MSG_FLAG_PUBL, Hdl::MSG_FLAG_PUBL_INDEX, Hdl::MSG_FLAG_RECU, Hdl::MSG_FLAG_RECU_INDEX, Hdl::MSG_FLAG_RRDG, Hdl::MSG_FLAG_RRDG_INDEX, Hdl::OC_ADD_VALUE, Hdl::OC_CHALLENGE_RESPONSE, Hdl::OC_CREATE_HANDLE, Hdl::OC_DELETE_HANDLE, Hdl::OC_GET_SITEINFO, Hdl::OC_LIST_HANDLE, Hdl::OC_LIST_NA, Hdl::OC_MODIFY_VALUE, Hdl::OC_REMOVE_VALUE, Hdl::OC_RESERVED, Hdl::OC_RESOLUTION, Hdl::OC_SESSION_EXCHANGEKEY, Hdl::OC_SESSION_SETUP, Hdl::OC_SESSION_TERMINATE, Hdl::OC_VERIFY_RESPONSE, Hdl::PERM_ADD_ADMIN, Hdl::PERM_ADD_HANDLE, Hdl::PERM_ADD_NA, Hdl::PERM_ADD_VALUE, Hdl::PERM_ALL, Hdl::PERM_DELETE_HANDLE, Hdl::PERM_DELETE_NA, Hdl::PERM_LIST_HDLS, Hdl::PERM_MODIFY_ADMIN, Hdl::PERM_MODIFY_VALUE, Hdl::PERM_READ_VALUE, Hdl::PERM_REMOVE_ADMIN, Hdl::PERM_REMOVE_VALUE, Hdl::RC_ACCESS_DENIED, Hdl::RC_AUTHEN_FAILED, Hdl::RC_AUTHEN_NEEDED, Hdl::RC_AUTHEN_TIMEOUT, Hdl::RC_ERROR, Hdl::RC_EXPIRED_SITE_INFO, Hdl::RC_FORWARDED, Hdl::RC_HANDLE_ALREADY_EXIST, Hdl::RC_HANDLE_NOT_FOUND, Hdl::RC_INVALID_CREDENTIAL, Hdl::RC_INVALID_HANDLE, Hdl::RC_NA_DELEGATE, Hdl::RC_NOT_AUTHORIZED, Hdl::RC_NO_SESSION_KEY, Hdl::RC_OPERATION_DENIED, Hdl::RC_PROTOCOL_ERROR, Hdl::RC_QUEUED, Hdl::RC_RECUR_LIMIT_EXCEEDED, Hdl::RC_RESERVED, Hdl::RC_SERVER_BUSY, Hdl::RC_SERVER_NOT_RESP, Hdl::RC_SERVICE_REFERRAL, Hdl::RC_SESSION_FAILED, Hdl::RC_SESSION_KEY_INVALID, Hdl::RC_SESSION_NO_SUPPORT, Hdl::RC_SESSION_TIMEOUT, Hdl::RC_SUCCESS, Hdl::RC_TRYING, Hdl::RC_UNABLE_TO_AUTHEN, Hdl::RC_VALUE_ALREADY_EXIST, Hdl::RC_VALUE_INVALID, Hdl::RC_VALUE_NOT_FOUND

Instance Method Summary collapse

Methods included from Hdl

#asBytes, #calculateValueLen, #convert16t8, #decodeAdminData, #encodeAdminData, #fromBytes, #readByteArray, #readIntArray, #readProtocolString, #toProtocolString

Methods inherited from BaseMessage

#authoritative, #authoritative=, #cacheCertify, #cacheCertify=, #certify, #certify=, #continuous, #continuous=, #digestAlg=, #encrypt, #encrypt=, #keepAlive, #keepAlive=, #publicOnly, #publicOnly=, #recursive, #recursive=, #returnRequestDigest, #returnRequestDigest=

Constructor Details

#initialize ⇒ BaseResponse

Returns a new instance of BaseResponse.



6
7
8
9
10
11
12
13
14
15
16
17
18
19
 
# File 'lib/cul/handles/base_response.rb', line 6

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

Instance Method Details

#body ⇒ Object 



135
136
137
 
# File 'lib/cul/handles/base_response.rb', line 135

def body
  @body
end

#credential ⇒ Object 



167
168
169
 
# File 'lib/cul/handles/base_response.rb', line 167

def credential
  @credential
end

#credentialType=(val) ⇒ Object 



170
171
172
 
# File 'lib/cul/handles/base_response.rb', line 170

def credentialType=(val)
  @credentialType = val
end

#debug=(val) ⇒ Object 



20
21
22
23
24
25
26
 
# File 'lib/cul/handles/base_response.rb', line 20

def debug=(val)
  if(val)
    @debug = true
  else
    @debug = false
  end
end

#opCode ⇒ Object 



108
109
110
 
# File 'lib/cul/handles/base_response.rb', line 108

def opCode
  return fromBytes(@opCode)
end

#packet ⇒ Object 



179
180
181
 
# File 'lib/cul/handles/base_response.rb', line 179

def packet
  @packet
end

#parseBody(data) ⇒ Object 



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/cul/handles/base_response.rb', line 120

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

#parseCredential(data) ⇒ Object 



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/cul/handles/base_response.rb', line 138

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

#parseEnvelope(data) ⇒ Object 



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/cul/handles/base_response.rb', line 55

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

#parseHeader(data) ⇒ Object 



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/cul/handles/base_response.rb', line 91

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

#requestId ⇒ Object 



88
89
90
 
# File 'lib/cul/handles/base_response.rb', line 88

def requestId
  return fromBytes(@requestId)
end

#responseCode ⇒ Object 



111
112
113
 
# File 'lib/cul/handles/base_response.rb', line 111

def responseCode
  return fromBytes(@responseCode)
end

#send(req, sock) ⇒ Object 



27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/cul/handles/base_response.rb', line 27

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

#sessionId ⇒ Object 



85
86
87
 
# File 'lib/cul/handles/base_response.rb', line 85

def sessionId
  return fromBytes(@sessionId)
end

#signedInfo=(val) ⇒ Object 



176
177
178
 
# File 'lib/cul/handles/base_response.rb', line 176

def signedInfo=(val)
  @signedInfo=val
end

#signedInfoAlg=(val) ⇒ Object 



173
174
175
 
# File 'lib/cul/handles/base_response.rb', line 173

def signedInfoAlg=(val)
  @signedInfoAlg = val
end

#siteInfoSerial ⇒ Object 



117
118
119
 
# File 'lib/cul/handles/base_response.rb', line 117

def siteInfoSerial
  return fromBytes(@siteInfoSerial)
end

#success? ⇒ Boolean

Returns:

  • (Boolean) 


114
115
116
 
# File 'lib/cul/handles/base_response.rb', line 114

def success?
  return @responseCode.eql?([0,0,0,1])
end

#to_s ⇒ Object 



182
183
184
185
186
187
188
 
# File 'lib/cul/handles/base_response.rb', line 182

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