module Ronin::Support::Network::SSL::Mixin

Provides helper methods for communicating with SSL-enabled services.

Public Instance Methods

ssl_accept(**kwargs,&block) click to toggle source

Creates a new SSL socket listening on a given host and port, accepts only one client and then stops listening.

@param [Hash{Symbol => Object}] kwargs

Additional keyword arguments for {#ssl_context}.

@!macro server_kwargs

@yield [client]

The given block will be passed the newly connected client.
After the block has finished, both the client and the server will
be closed.

@yieldparam [OpenSSL::SSL::SSLSocket] client

The newly connected client.

@return [nil]

@example

ssl_accept(1337) do |client|
  client.puts 'lol'
end

@example Using a self-signed certificate:

# $ openssl genrsa -out ssl.key 1024
# $ openssl req -new -key ssl.key -x509 -days 3653 -out ssl.crt
# $ cat ssl.key ssl.crt > ssl.pem
# $ chmod 600 ssl.key ssl.pem
ssl_accept(port: 1337, cert: 'ssl.crt', key: 'ssl.key') do |client|
  client.puts 'lol'
end

@api public

@see SSL.accept

@since 0.6.0

# File lib/ronin/support/network/ssl/mixin.rb, line 504
def ssl_accept(**kwargs,&block)
  SSL.accept(**kwargs,&block)
end
ssl_banner(host,port,**kwargs,&block) click to toggle source

Reads the banner from the service running on the given host and port.

@param [String] host

The host to connect to.

@param [Integer] port

The port to connect to.

@param [Hash{Symbol => Object}] kwargs

Additional keyword arguments for {#ssl_connect}.

@!macro connect_kwargs

@yield [banner]

If a block is given, it will be passed the grabbed banner.

@yieldparam [String] banner

The grabbed banner.

@return [String]

The grabbed banner.

@example

ssl_banner('smtp.gmail.com',465)
# => "220 mx.google.com ESMTP c20sm3096959rvf.1"

@api public

@see SSL.banner

@since 0.6.0

# File lib/ronin/support/network/ssl/mixin.rb, line 287
def ssl_banner(host,port,**kwargs,&block)
  SSL.banner(host,port,**kwargs,&block)
end
ssl_cert(host,port,**kwargs) click to toggle source

Connects to the host and port and returns the server’s certificate.

@param [String] host

The host to connect to.

@param [Integer] port

The port to connect to.

@param [Hash{Symbol => Object}] kwargs

Additional keyword arguments {#ssl_connect}.

@!macro connect_kwargs

@return [Crypto::Cert]

The server's certificate.

@see SSL.get_cert

# File lib/ronin/support/network/ssl/mixin.rb, line 249
def ssl_cert(host,port,**kwargs)
  SSL.get_cert(host,port,**kwargs)
end
ssl_connect(host,port,**kwargs,&block) click to toggle source

Establishes a SSL connection.

@param [String] host

The host to connect to.

@param [Integer] port

The port to connect to.

@param [Hash{Symbol => Object}] kwargs

Additional keyword arguments for {#ssl_socket}.

@!macro connect_kwargs

@yield [ssl_socket]

The given block will be passed the new SSL socket. Once the block
returns the SSL socket will be closed.

@yieldparam [OpenSSL::SSL::SSLSocket] ssl_socket

The new SSL Socket.

@return [OpenSSL::SSL::SSLSocket, nil]

The new SSL Socket. If a block is given, then `nil` will be
returned.

@example

socket = ssl_connect('twitter.com',443)

@example

ssl_connect('twitter.com',443) do |sock|
  sock.write("GET / HTTP/1.1\n\r\n\r")

  sock.each_line { |line| puts line }
end

@see rubydoc.info/stdlib/openssl/OpenSSL/SSL/SSLSocket @see SSL.connect

@api public

# File lib/ronin/support/network/ssl/mixin.rb, line 193
def ssl_connect(host,port,**kwargs,&block)
  SSL.connect(host,port,**kwargs,&block)
end
ssl_connect_and_send(data,host,port,**kwargs,&block) click to toggle source

Creates a new SSL connection and sends the given data.

@param [String] data

The data to send through the connection.

@param [String] host

The host to connect to.

@param [Integer] port

The port to connect to.

@param [Hash{Symbol => Object}] kwargs

Additional keyword arguments for {#ssl_connect}.

@!macro connect_kwargs

@yield [ssl_socket]

The given block will be passed the newly created SSL Socket.

@yieldparam [OpenSSL::SSL::SSLSocket] ssl_socket

The newly created SSL Socket.

@api public

@see SSL.connect_and_send

@since 0.6.0

# File lib/ronin/support/network/ssl/mixin.rb, line 226
def ssl_connect_and_send(data,host,port,**kwargs,&block)
  SSL.connect_and_send(data,host,port,**kwargs,&block)
end
ssl_context(**kwargs) click to toggle source

Creates a new SSL Context.

@param [Hash{Symbol => Object}] kwargs

Additional keyword arguments.

@!macro context_kwargs

@return [OpenSSL::SSL::SSLContext]

The newly created SSL Context.

@api semipublic

@see SSL.context

@since 0.6.0

# File lib/ronin/support/network/ssl/mixin.rb, line 76
def ssl_context(**kwargs)
  SSL.context(**kwargs)
end
ssl_open?(host,port,**kwargs) click to toggle source

Tests whether a remote SSLed TCP port is open.

@param [String] host

The host to connect to.

@param [Integer] port

The port to connect to.

@param [Hash{Symbol => Object}] kwargs

Additional keyword arguments for {#ssl_connect}.

@!macro connect_kwargs

@option kwargs [Integer] :timeout (5)

The maximum time to attempt connecting.

@return [Boolean, nil]

Specifies whether the remote SSLed TCP port is open.
If the connection was not accepted, `nil` will be returned.

@example

ssl_open?('www.bankofamerica.com',443)

@example Using a timeout:

ssl_open?('example.com',80, timeout: 5)
# => nil

@api public

@see SSL.open?

@since 0.6.0

# File lib/ronin/support/network/ssl/mixin.rb, line 149
def ssl_open?(host,port,**kwargs)
  SSL.open?(host,port,**kwargs)
end
ssl_send(data,host,port,**kwargs) click to toggle source

Connects to a specified host and port, sends the given data and then closes the connection.

@param [String] data

The data to send through the connection.

@param [String] host

The host to connect to.

@param [Integer] port

The port to connect to.

@param [Hash{Symbol => Object}] kwargs

Additional keyword arguments for {#ssl_connect}.

@!macro connect_kwargs

@return [true]

The data was successfully sent.

@example

buffer = "GET /#{'A' * 4096}\n\r"
ssl_send(buffer,'victim.com',443)
# => true

@api public

@see SSL.send

@since 0.6.0

# File lib/ronin/support/network/ssl/mixin.rb, line 323
def ssl_send(data,host,port,**kwargs)
  SSL.send(data,host,port,**kwargs)
end
ssl_server(**kwargs,&block) click to toggle source

Creates a new SSL server listening on a given host and port.

@param [Hash{Symbol => Object}] kwargs

Additional keyword arguments for {#ssl_context}.

@!macro server_kwargs

@yield [server]

The given block will be passed the newly created SSL server.

@yieldparam [OpenSSL::SSL::SSLServer] server

The newly created SSL server.

@return [OpenSSL::SSL::SSLServer]

The newly created SSL server.

@api public

@since 1.1.0

# File lib/ronin/support/network/ssl/mixin.rb, line 397
def ssl_server(**kwargs,&block)
  SSL.server(**kwargs,&block)
end
ssl_server_loop(**kwargs,&block) click to toggle source

Creates a new SSL socket listening on a given host and port, accepting clients in a loop.

@param [Hash{Symbol => Object}] kwargs

Additional keyword arguments for {#ssl_context}.

@!macro server_kwargs

@yield [client]

The given block will be passed the newly connected client.
After the block has finished, the client will be closed.

@yieldparam [OpenSSL::SSL::SSLSocket] client

A newly connected client.

@return [nil]

@example

# $ openssl genrsa -out ssl.key 1024
# $ openssl req -new -key ssl.key -x509 -days 3653 -out ssl.crt
# $ cat ssl.key ssl.crt > ssl.pem
# $ chmod 600 ssl.key ssl.pem
ssl_server_loop(port: 1337, cert: 'ssl.crt', key: 'ssl.key') do |sock|
  sock.puts 'lol'
end

@api public

@see SSL.server_loop

@since 0.6.0

# File lib/ronin/support/network/ssl/mixin.rb, line 461
def ssl_server_loop(**kwargs,&block)
  SSL.server_loop(**kwargs,&block)
end
ssl_server_session(**kwargs,&block) click to toggle source

Creates a new temporary SSL server listening on a given host and port.

@param [Hash{Symbol => Object}] kwargs

Additional keyword arguments for {#ssl_context}.

@!macro server_kwargs

@yield [server]

The given block will be passed the newly created SSL server.
Once the block has finished, the server will be closed.

@yieldparam [OpenSSL::SSL::SSLServer] server

The newly created SSL server.

@return [OpenSSL::SSL::SSLServer]

The newly created SSL server.

@api public

@since 1.1.0

# File lib/ronin/support/network/ssl/mixin.rb, line 424
def ssl_server_session(**kwargs,&block)
  SSL.server_session(**kwargs,&block)
end
ssl_server_socket(socket,**kwargs) click to toggle source

Accepts an SSL session from an existing TCP socket.

@param [TCPSocket] socket

The existing TCP socket.

@param [Hash{Symbol => Object}] kwargs

Additional keyword arguments for {#ssl_socket}.

@!macro server_context_kwargs

@return [OpenSSL::SSL::SSLSocket]

The new SSL Socket.

@api public

@see SSL.server_socket

@since 0.6.0

# File lib/ronin/support/network/ssl/mixin.rb, line 358
def ssl_server_socket(socket,**kwargs)
  SSL.server_socket(socket,**kwargs)
end
ssl_socket(socket,**kwargs) click to toggle source

Initiates an SSL session with an existing TCP socket.

@param [TCPSocket] socket

The existing TCP socket.

@param [Hash{Symbol => Object}] kwargs

Additional keyword arguments for {#ssl_context}.

@!macro context_kwargs

@return [OpenSSL::SSL::SSLSocket]

The new SSL Socket.

@api public

@see SSL.socket

@since 0.6.0

# File lib/ronin/support/network/ssl/mixin.rb, line 100
def ssl_socket(socket,**kwargs)
  SSL.socket(socket,**kwargs)
end