class HTTPClient::SSLSocketWrap

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

Public Class Methods

new(socket, context, debug_dev = nil) click to toggle source
# File lib/httpclient/session.rb, line 300
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

Public Instance Methods

<<(str) click to toggle source
# File lib/httpclient/session.rb, line 380
def <<(str)
  rv = @ssl_socket.write(str)
  debug(str)
  rv
end
close() click to toggle source
# File lib/httpclient/session.rb, line 349
def close
  @ssl_socket.close
  @socket.close
end
closed?() click to toggle source
# File lib/httpclient/session.rb, line 354
def closed?
  @socket.closed?
end
eof?() click to toggle source
# File lib/httpclient/session.rb, line 358
def eof?
  @ssl_socket.eof?
end
flush() click to toggle source
# File lib/httpclient/session.rb, line 386
def flush
  @ssl_socket.flush
end
gets(*args) click to toggle source
# File lib/httpclient/session.rb, line 362
def gets(*args)
  str = @ssl_socket.gets(*args)
  debug(str)
  str
end
peer_cert() click to toggle source
# File lib/httpclient/session.rb, line 345
def peer_cert
  @ssl_socket.peer_cert
end
post_connection_check(host) click to toggle source
# File lib/httpclient/session.rb, line 317
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) click to toggle source
# File lib/httpclient/session.rb, line 368
def read(*args)
  str = @ssl_socket.read(*args)
  debug(str)
  str
end
readpartial(*args) click to toggle source
# File lib/httpclient/session.rb, line 374
def readpartial(*args)
  str = @ssl_socket.readpartial(*args)
  debug(str)
  str
end
ssl_cipher() click to toggle source
# File lib/httpclient/session.rb, line 337
def ssl_cipher
  @ssl_socket.cipher
end
ssl_connect(hostname = nil) click to toggle source
# File lib/httpclient/session.rb, line 310
def ssl_connect(hostname = nil)
  if hostname && @ssl_socket.respond_to?(:hostname=)
    @ssl_socket.hostname = hostname
  end
  @ssl_socket.connect
end
ssl_state() click to toggle source
# File lib/httpclient/session.rb, line 341
def ssl_state
  @ssl_socket.state
end
ssl_version() click to toggle source
# File lib/httpclient/session.rb, line 333
def ssl_version
  @ssl_socket.ssl_version if @ssl_socket.respond_to?(:ssl_version)
end
sync() click to toggle source
# File lib/httpclient/session.rb, line 390
def sync
  @ssl_socket.sync
end
sync=(sync) click to toggle source
# File lib/httpclient/session.rb, line 394
def sync=(sync)
  @ssl_socket.sync = sync
end

Private Instance Methods

check_mask(value, mask) click to toggle source
# File lib/httpclient/session.rb, line 400
def check_mask(value, mask)
  value & mask == mask
end
create_openssl_socket(socket) click to toggle source
# File lib/httpclient/session.rb, line 404
def create_openssl_socket(socket)
  ssl_socket = nil
  if OpenSSL::SSL.const_defined?("SSLContext")
    ctx = OpenSSL::SSL::SSLContext.new
    @context.set_context(ctx)
    ssl_socket = OpenSSL::SSL::SSLSocket.new(socket, ctx)
  else
    ssl_socket = OpenSSL::SSL::SSLSocket.new(socket)
    @context.set_context(ssl_socket)
  end
  ssl_socket
end
debug(str) click to toggle source
# File lib/httpclient/session.rb, line 417
def debug(str)
  @debug_dev << str if @debug_dev && str
end