class PacketThief::Handlers::SSLServer

Basic SSL/TLS Server built on Ruby’s OpenSSL objects instead of on EventMachine’s start_tls. This allows you to manipulate the SSLContext and other details of the connection that EM normally doesn’t let you touch.

Subclass it and override any of the methods in the following example to use the the functionality.

You can send_data to send encrypted data to the other side, and receive_data will be called when there is data for the handler.

EM.run {
  # Leave the hostname blank for Linux's netfilter.
  SSLServer.start '', 54321 do |p|

    # Note: this code block is actually too late to set up a new
    # #post_init since it runs just after post_init. Instead, you would
    # use post_init in a subclass.
    def p.post_init
      # modify p.ctx to configure your certificates, key, etc.
    end

    # In this example, the following would work in this initialization
    # block:
    h.ctx.cert = cert
    h.ctx.extra_chain_cert = chain
    h.ctx.key = key

    def servername_cb(sock, hostname)
      # implement your own SNI handling callback. The default will
      # return the originally configured context.
    end

    def p.tls_successful_handshake
      # the handshake succeeded
    end

    def p.tls_failed_handshake(e)
      # the ssl handshake failed, probably due to the client rejecting
      # your certificate. =)
    end

    def p.unbind
      # unbind handler, called regardless of handshake success
    end

    def p.receive_data(data)
      # do something with the unencrypted stream
      p.send_data("some message") # data to be encrypted then sent to the client
    end

  end
}

Note: During initialize and post_init, this class does not have access to its socket yet. Instead, use tls_pre_start or the code block you pass to .start to initialize the SSLContext, and use tls_post_accept to do anything once the SSL handshake has completed. You can also override servername_cb to perform the SNI callback.

Attributes

server_handler[RW]

reference to the InitialServer that created the current handler. exists so you can call stop_server or do something else to it directly.

Public Class Methods

new(tcpsocket,logger=nil) click to toggle source
# File lib/packetthief/handlers/ssl_server.rb, line 148
def initialize(tcpsocket,logger=nil)
  super(tcpsocket, logger)
  @ctx.servername_cb = proc {|sslsocket, hostname| self.servername_cb(sslsocket, hostname) }
end
start(host, port, *args, &block) click to toggle source
# File lib/packetthief/handlers/ssl_server.rb, line 69
def self.start(host, port, *args, &block)
  ssl_class = self

  serv = TCPServer.new host, port

  # We use InitialServer to listen for incoming connections. It will then
  # create the actual SSLServer.
  initialserver = ::EM.watch serv, InitialServer, serv, ssl_class, args, block do |h|
    h.notify_readable = true
  end

  initialserver
end

Public Instance Methods

servername_cb(sslsock, hostname) click to toggle source

Called when the client sends a hostname using the SNI TLS extension.

This method should return an OpenSSL::SSL::SSLContext. It gives you an opportunity to pick or generate a different server certificate or certificate chain based on the hostname requested by the client.

The default implementation does nothing by just returning the original SSLContext.

# File lib/packetthief/handlers/ssl_server.rb, line 162
def servername_cb(sslsock, hostname)
  sslsock.context
end
stop_server() click to toggle source

Stops the InitialListener sever handler that spawned this handler. Due to our use of EM.watch, we can’t rely on EM to close the socket.

# File lib/packetthief/handlers/ssl_server.rb, line 168
def stop_server
  @server_handler.stop_server
end