Class: HTTPClient::SSLSocketWrap

Inherits:
Object
  • Object
show all
Defined in:
lib/httpclient/session.rb

Overview

Wraps up OpenSSL::SSL::SSLSocket and offers debugging features.

Instance Method Summary collapse

Constructor Details

#initialize(socket, context, debug_dev = nil) ⇒ SSLSocketWrap

Returns a new instance of SSLSocketWrap.



286
287
288
289
290
291
292
293
294
 
# File 'lib/httpclient/session.rb', line 286

def initialize(socket, context, debug_dev = nil)
  unless SSLEnabled
    raise ConfigurationError.new('Ruby/OpenSSL module is required')
  end
  @context = context
  @socket = socket
  @ssl_socket = create_openssl_socket(@socket)
  @debug_dev = debug_dev
end

Instance Method Details

#<<(str) ⇒ Object 



366
367
368
369
370
 
# File 'lib/httpclient/session.rb', line 366

def <<(str)
  rv = @ssl_socket.write(str)
  debug(str)
  rv
end

#close ⇒ Object 



335
336
337
338
 
# File 'lib/httpclient/session.rb', line 335

def close
  @ssl_socket.close
  @socket.close
end

#closed? ⇒ Boolean

Returns:

  • (Boolean) 


340
341
342
 
# File 'lib/httpclient/session.rb', line 340

def closed?
  @socket.closed?
end

#eof? ⇒ Boolean

Returns:

  • (Boolean) 


344
345
346
 
# File 'lib/httpclient/session.rb', line 344

def eof?
  @ssl_socket.eof?
end

#flush ⇒ Object 



372
373
374
 
# File 'lib/httpclient/session.rb', line 372

def flush
  @ssl_socket.flush
end

#gets(*args) ⇒ Object 



348
349
350
351
352
 
# File 'lib/httpclient/session.rb', line 348

def gets(*args)
  str = @ssl_socket.gets(*args)
  debug(str)
  str
end

#peer_cert ⇒ Object 



331
332
333
 
# File 'lib/httpclient/session.rb', line 331

def peer_cert
  @ssl_socket.peer_cert
end

#post_connection_check(host) ⇒ Object 



303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/httpclient/session.rb', line 303

def post_connection_check(host)
  verify_mode = @context.verify_mode || OpenSSL::SSL::VERIFY_NONE
  if verify_mode == OpenSSL::SSL::VERIFY_NONE
    return
  elsif @ssl_socket.peer_cert.nil? and
    check_mask(verify_mode, OpenSSL::SSL::VERIFY_FAIL_IF_NO_PEER_CERT)
    raise OpenSSL::SSL::SSLError.new('no peer cert')
  end
  hostname = host.host
  if @ssl_socket.respond_to?(:post_connection_check) and RUBY_VERSION > "1.8.4"
    @ssl_socket.post_connection_check(hostname)
  else
    @context.post_connection_check(@ssl_socket.peer_cert, hostname)
  end
end

#read(*args) ⇒ Object 



354
355
356
357
358
 
# File 'lib/httpclient/session.rb', line 354

def read(*args)
  str = @ssl_socket.read(*args)
  debug(str)
  str
end

#readpartial(*args) ⇒ Object 



360
361
362
363
364
 
# File 'lib/httpclient/session.rb', line 360

def readpartial(*args)
  str = @ssl_socket.readpartial(*args)
  debug(str)
  str
end

#ssl_cipher ⇒ Object 



323
324
325
 
# File 'lib/httpclient/session.rb', line 323

def ssl_cipher
  @ssl_socket.cipher
end

#ssl_connect(hostname = nil) ⇒ Object 



296
297
298
299
300
301
 
# File 'lib/httpclient/session.rb', line 296

def ssl_connect(hostname = nil)
  if hostname && @ssl_socket.respond_to?(:hostname=)
    @ssl_socket.hostname = hostname
  end
  @ssl_socket.connect
end

#ssl_state ⇒ Object 



327
328
329
 
# File 'lib/httpclient/session.rb', line 327

def ssl_state
  @ssl_socket.state
end

#ssl_version ⇒ Object 



319
320
321
 
# File 'lib/httpclient/session.rb', line 319

def ssl_version
  @ssl_socket.ssl_version if @ssl_socket.respond_to?(:ssl_version)
end

#sync ⇒ Object 



376
377
378
 
# File 'lib/httpclient/session.rb', line 376

def sync
  @ssl_socket.sync
end

#sync=(sync) ⇒ Object 



380
381
382
 
# File 'lib/httpclient/session.rb', line 380

def sync=(sync)
  @ssl_socket.sync = sync
end