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


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

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


368
369
370
371
372
# File 'lib/httpclient/session.rb', line 368

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

#closeObject


337
338
339
340
# File 'lib/httpclient/session.rb', line 337

def close
  @ssl_socket.close
  @socket.close
end

#closed?Boolean

Returns:

  • (Boolean)

342
343
344
# File 'lib/httpclient/session.rb', line 342

def closed?
  @socket.closed?
end

#eof?Boolean

Returns:

  • (Boolean)

346
347
348
# File 'lib/httpclient/session.rb', line 346

def eof?
  @ssl_socket.eof?
end

#flushObject


374
375
376
# File 'lib/httpclient/session.rb', line 374

def flush
  @ssl_socket.flush
end

#gets(*args) ⇒ Object


350
351
352
353
354
# File 'lib/httpclient/session.rb', line 350

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

#peer_certObject


333
334
335
# File 'lib/httpclient/session.rb', line 333

def peer_cert
  @ssl_socket.peer_cert
end

#post_connection_check(host) ⇒ Object


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

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


356
357
358
359
360
# File 'lib/httpclient/session.rb', line 356

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

#readpartial(*args) ⇒ Object


362
363
364
365
366
# File 'lib/httpclient/session.rb', line 362

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

#ssl_cipherObject


325
326
327
# File 'lib/httpclient/session.rb', line 325

def ssl_cipher
  @ssl_socket.cipher
end

#ssl_connect(hostname = nil) ⇒ Object


298
299
300
301
302
303
# File 'lib/httpclient/session.rb', line 298

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

#ssl_stateObject


329
330
331
# File 'lib/httpclient/session.rb', line 329

def ssl_state
  @ssl_socket.state
end

#ssl_versionObject


321
322
323
# File 'lib/httpclient/session.rb', line 321

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

#syncObject


378
379
380
# File 'lib/httpclient/session.rb', line 378

def sync
  @ssl_socket.sync
end

#sync=(sync) ⇒ Object


382
383
384
# File 'lib/httpclient/session.rb', line 382

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