lib/ronin/network/ssl.rb in ronin-support-0.4.0 vs lib/ronin/network/ssl.rb in ronin-support-0.4.1

@@ -20,19 +20,20 @@
 require 'ronin/network/tcp'
 
 begin
   require 'openssl'
 rescue ::LoadError
+  $stderr.puts "WARNING: Ruby was not compiled with OpenSSL support"
 end
 
 module Ronin
   module Network
     #
     # Provides helper methods for communicating with SSL-enabled services.
     #
     module SSL
-      extend TCP
+      include TCP
 
       # Maps SSL verify modes to `OpenSSL::SSL::VERIFY_*` constants.
       #
       # @return [Hash{Symbol => Integer}]
       #
@@ -51,132 +52,136 @@
           raise(RuntimeError,"unknown verify mode #{key}")
         end
 
         hash[key] = OpenSSL::SSL.const_get(verify_const)
       end
-    end
 
-    #
-    # Establishes a SSL connection.
-    #
-    # @param [String] host
-    #   The host to connect to.
-    #
-    # @param [Integer] port
-    #   The port to connect to.
-    #
-    # @param [Hash] options
-    #   Additional options.
-    #
-    # @option options [String] :local_host
-    #   The local host to bind to.
-    #
-    # @option options [Integer] :local_port
-    #   The local port to bind to.
-    #
-    # @option options [Symbol] :verify
-    #   Specifies whether to verify the SSL certificate.
-    #   May be one of the following:
-    #
-    #   * `:none`
-    #   * `:peer`
-    #   * `:client_once`
-    #   * `:fail_if_no_peer_cert`
-    #
-    # @option options [String] :cert
-    #   The path to the SSL certificate.
-    #
-    # @option options [String] :key
-    #   The path to the SSL key.
-    #
-    # @yield [ssl_socket]
-    #   The given block will be passed the new SSL Socket.
-    #
-    # @yieldparam [OpenSSL::SSL::SSLSocket] ssl_socket
-    #   The new SSL Socket.
-    #
-    # @return [OpenSSL::SSL::SSLSocket]
-    #   the new SSL Socket.
-    #
-    # @example
-    #   socket = ssl_connect('twitter.com',443)
-    #
-    # @api public
-    #
-    def ssl_connect(host,port,options={})
-      local_host = options[:local_host]
-      local_port = options[:local_port]
+      #
+      # Establishes a SSL connection.
+      #
+      # @param [String] host
+      #   The host to connect to.
+      #
+      # @param [Integer] port
+      #   The port to connect to.
+      #
+      # @param [Hash] options
+      #   Additional options.
+      #
+      # @option options [String] :local_host
+      #   The local host to bind to.
+      #
+      # @option options [Integer] :local_port
+      #   The local port to bind to.
+      #
+      # @option options [Symbol] :verify
+      #   Specifies whether to verify the SSL certificate.
+      #   May be one of the following:
+      #
+      #   * `:none`
+      #   * `:peer`
+      #   * `:client_once`
+      #   * `:fail_if_no_peer_cert`
+      #
+      # @option options [String] :cert
+      #   The path to the SSL certificate.
+      #
+      # @option options [String] :key
+      #   The path to the SSL key.
+      #
+      # @yield [ssl_socket]
+      #   The given block will be passed the new SSL Socket.
+      #
+      # @yieldparam [OpenSSL::SSL::SSLSocket] ssl_socket
+      #   The new SSL Socket.
+      #
+      # @return [OpenSSL::SSL::SSLSocket]
+      #   the new SSL Socket.
+      #
+      # @example
+      #   socket = ssl_connect('twitter.com',443)
+      #
+      # @see http://rubydoc.info/stdlib/openssl/OpenSSL/SSL/SSLSocket
+      #
+      # @api public
+      #
+      def ssl_connect(host,port,options={})
+        local_host = options[:local_host]
+        local_port = options[:local_port]
 
-      socket = tcp_connect(host,port,local_host,local_port)
+        socket = tcp_connect(host,port,local_host,local_port)
 
-      ssl_context = OpenSSL::SSL::SSLContext.new()
-      ssl_context.verify_mode = SSL::VERIFY[options[:verify]]
+        ssl_context = OpenSSL::SSL::SSLContext.new()
+        ssl_context.verify_mode = SSL::VERIFY[options[:verify]]
 
-      if options[:cert]
-        cert_file = File.new(options[:cert])
-        ssl_context.cert = OpenSSL::X509::Certificate.new(cert_file)
-      end
+        if options[:cert]
+          cert_file = File.new(options[:cert])
+          ssl_context.cert = OpenSSL::X509::Certificate.new(cert_file)
+        end
 
-      if options[:key]
-        key_file = File.new(options[:key])
-        ssl_context.key = OpenSSL::PKey::RSA.new(key_file)
-      end
+        if options[:key]
+          key_file = File.new(options[:key])
+          ssl_context.key = OpenSSL::PKey::RSA.new(key_file)
+        end
 
-      ssl_socket = OpenSSL::SSL::SSLSocket.new(socket,ssl_context)
-      ssl_socket.sync_close = true
-      ssl_socket.connect
+        ssl_socket = OpenSSL::SSL::SSLSocket.new(socket,ssl_context)
+        ssl_socket.sync_close = true
+        ssl_socket.connect
 
-      yield ssl_socket if block_given?
-      return ssl_socket
-    end
+        yield ssl_socket if block_given?
+        return ssl_socket
+      end
 
-    #
-    # Creates a new temporary SSL connection.
-    #
-    # @param [String] host
-    #   The host to connect to.
-    #
-    # @param [Integer] port
-    #   The port to connect to.
-    #
-    # @param [Hash] options
-    #   Additional options.
-    #
-    # @option options [String] :local_host
-    #   The local host to bind to.
-    #
-    # @option options [Integer] :local_port
-    #   The local port to bind to.
-    #
-    # @option options [Symbol] :verify
-    #   Specifies whether to verify the SSL certificate.
-    #
-    # @option options [String] :cert
-    #   The path to the SSL certificate.
-    #
-    # @option options [String] :key
-    #   The path to the SSL key.
-    #
-    # @yield [ssl_socket]
-    #   The given block will be passed the temporary SSL Socket.
-    #
-    # @yieldparam [OpenSSL::SSL::SSLSocket] ssl_socket
-    #   The temporary SSL Socket.
-    #
-    # @return [nil]
-    #
-    # @example
-    #   ssl_session('twitter.com',443) do |sock|
-    #     sock.write("GET /\n\n")
-    #
-    #     sock.each_line { |line| puts line }
-    #   end
-    #
-    # @api public
-    #
-    def ssl_session(host,port,options={},&block)
-      ssl_socket = ssl_connect(host,port,options,&block)
-      ssl_socket.close
-      return nil
+      #
+      # Creates a new temporary SSL connection.
+      #
+      # @param [String] host
+      #   The host to connect to.
+      #
+      # @param [Integer] port
+      #   The port to connect to.
+      #
+      # @param [Hash] options
+      #   Additional options.
+      #
+      # @option options [String] :local_host
+      #   The local host to bind to.
+      #
+      # @option options [Integer] :local_port
+      #   The local port to bind to.
+      #
+      # @option options [Symbol] :verify
+      #   Specifies whether to verify the SSL certificate.
+      #
+      # @option options [String] :cert
+      #   The path to the SSL certificate.
+      #
+      # @option options [String] :key
+      #   The path to the SSL key.
+      #
+      # @yield [ssl_socket]
+      #   The given block will be passed the temporary SSL Socket.
+      #
+      # @yieldparam [OpenSSL::SSL::SSLSocket] ssl_socket
+      #   The temporary SSL Socket.
+      #
+      # @return [nil]
+      #
+      # @example
+      #   ssl_session('twitter.com',443) do |sock|
+      #     sock.write("GET / HTTP/1.1\n\r\n\r")
+      #
+      #     sock.each_line { |line| puts line }
+      #   end
+      #
+      # @see http://rubydoc.info/stdlib/openssl/OpenSSL/SSL/SSLSocket
+      #
+      # @api public
+      #
+      def ssl_session(host,port,options={},&block)
+        ssl_socket = ssl_connect(host,port,options,&block)
+        ssl_socket.close
+        return nil
+      end
     end
   end
 end