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.



348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/openssl/ssl.rb', line 348

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_immediately ⇒ Object

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



343
344
345
 
# File 'lib/openssl/ssl.rb', line 343

def start_immediately
  @start_immediately
end

Instance Method Details

#accept ⇒ Object

Works similar to TCPServer#accept.



376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
 
# File 'lib/openssl/ssl.rb', line 376

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

#close ⇒ Object

See IO#close for details.



397
398
399
 
# File 'lib/openssl/ssl.rb', line 397

def close
  @svr.close
end

#listen(backlog = 5) ⇒ Object

See TCPServer#listen for details.



366
367
368
 
# File 'lib/openssl/ssl.rb', line 366

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

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

See BasicSocket#shutdown for details.



371
372
373
 
# File 'lib/openssl/ssl.rb', line 371

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

#to_io ⇒ Object

Returns the TCPServer passed to the SSLServer when initialized.



361
362
363
 
# File 'lib/openssl/ssl.rb', line 361

def to_io
  @svr
end