Class: OpenSSL::SSL::SSLServer

Inherits:
Object
  • Object
show all
Includes:
SocketForwarder
Defined in:
lib/openssl/ssl.rb

Overview

SSLServer represents a TCP/IP server socket with Secure Sockets Layer.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from SocketForwarder

#addr, #closed?, #do_not_reverse_lookup=, #fcntl, #getsockopt, #peeraddr, #setsockopt

Constructor Details

#initialize(svr, ctx) ⇒ SSLServer

Creates a new instance of SSLServer.

  • srv is an instance of TCPServer.

  • ctx is an instance of OpenSSL::SSL::SSLContext.


450
451
452
453
454
455
456
457
458
459
460
# File 'lib/openssl/ssl.rb', line 450

def initialize(svr, ctx)
  @svr = svr
  @ctx = ctx
  unless ctx.session_id_context
    # see #6137 - session id may not exceed 32 bytes
    prng = ::Random.new($0.hash)
    session_id = prng.bytes(16).unpack('H*')[0]
    @ctx.session_id_context = session_id
  end
  @start_immediately = true
end

Instance Attribute Details

#start_immediatelyObject

When true then #accept works exactly the same as TCPServer#accept


445
446
447
# File 'lib/openssl/ssl.rb', line 445

def start_immediately
  @start_immediately
end

Instance Method Details

#acceptObject

Works similar to TCPServer#accept.


478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
# File 'lib/openssl/ssl.rb', line 478

def accept
  # Socket#accept returns [socket, addrinfo].
  # TCPServer#accept returns a socket.
  # The following comma strips addrinfo.
  sock, = @svr.accept
  begin
    ssl = OpenSSL::SSL::SSLSocket.new(sock, @ctx)
    ssl.sync_close = true
    ssl.accept if @start_immediately
    ssl
  rescue Exception => ex
    if ssl
      ssl.close
    else
      sock.close
    end
    raise ex
  end
end

#closeObject

See IO#close for details.


499
500
501
# File 'lib/openssl/ssl.rb', line 499

def close
  @svr.close
end

#listen(backlog = 5) ⇒ Object

See TCPServer#listen for details.


468
469
470
# File 'lib/openssl/ssl.rb', line 468

def listen(backlog=5)
  @svr.listen(backlog)
end

#shutdown(how = Socket::SHUT_RDWR) ⇒ Object

See BasicSocket#shutdown for details.


473
474
475
# File 'lib/openssl/ssl.rb', line 473

def shutdown(how=Socket::SHUT_RDWR)
  @svr.shutdown(how)
end

#to_ioObject

Returns the TCPServer passed to the SSLServer when initialized.


463
464
465
# File 'lib/openssl/ssl.rb', line 463

def to_io
  @svr
end