ronin-support 1.0.6 → 1.1.0.rc1

data/lib/ronin/support/network/tls/proxy.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2006-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # Ronin Support is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published

data/lib/ronin/support/network/tls.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2006-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-support is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published
@@ -29,21 +29,507 @@ module Ronin
         include SSL
 
         #
-        # Creates a new SSL Context.
+        # @!macro context_kwargs
+        #   @option kwargs [1, 1.1, 1.2, 1.3, Symbol, nil] :version
+        #     The SSL version to use.
         #
-        # @param [1, 1.1, 1.2, String, Symbol, nil] version
-        #   The SSL version to use.
+        #   @option kwargs [1, 1.1, 1.2, 1.3, Symbol, nil] :min_version
+        #     The minimum SSL version to use.
+        #
+        #   @option kwargs [1, 1.1, 1.2, 1.3, Symbol, nil] :max_version
+        #     The maximum SSL version to use.
+        #
+        #   @option kwargs [Symbol, Boolean] :verify
+        #     Specifies whether to verify the SSL certificate.
+        #     May be one of the following:
+        #
+        #     * `:none`
+        #     * `:peer`
+        #     * `:fail_if_no_peer_cert`
+        #     * `:client_once`
+        #
+        #   @option kwargs [Crypto::Key::RSA, OpenSSL::PKey::RSA, nil] :key
+        #     The RSA key to use for the SSL context.
+        #
+        #   @option kwargs [String] :key_file
+        #     The path to the SSL `.key` file.
+        #
+        #   @option kwargs [Crypto::Cert, OpenSSL::X509::Certificate, nil] :cert
+        #     The X509 certificate to use for the SSL context.
+        #
+        #   @option kwargs [String] :cert_file
+        #     The path to the SSL `.crt` file.
+        #
+        #   @option kwargs [String] :ca_bundle
+        #     Path to the CA certificate file or directory.
+        #
+
+        #
+        # Creates a new TLS context.
+        #
+        # @param [1, 1.1, 1.2, 1.3, Symbol, nil] min_version
+        #   The minimum TLS version to use.
         #
         # @param [Hash{Symbol => Object}] kwargs
         #   Additional keyword arguments for {SSL.context}.
         #
+        # @!macro context_kwargs
+        #
         # @return [OpenSSL::SSL::SSLContext]
         #   The newly created SSL Context.
         #
         # @api semipublic
         #
-        def self.context(version: 1.2, **kwargs)
-          SSL.context(version: version, **kwargs)
+        def self.context(min_version: 1, **kwargs)
+          SSL.context(min_version: min_version, **kwargs)
+        end
+
+        #
+        # Initiates an SSL session with an existing TCP socket.
+        #
+        # @param [TCPSocket] socket
+        #   The existing TCP socket.
+        #
+        # @param [1, 1.1, 1.2, 1.3, Symbol, nil] min_version
+        #   The minimum TLS version to use.
+        #
+        # @param [Hash{Symbol => Object}] kwargs
+        #   Additional keyword arguments for {SSL.context}.
+        #
+        # @!macro context_kwargs
+        #
+        # @return [OpenSSL::SSL::SSLSocket]
+        #   the new SSL Socket.
+        #
+        # @api public
+        #
+        # @since 1.1.0
+        #
+        def self.socket(socket, min_version: 1, **kwargs)
+          SSL.socket(socket,min_version: min_version, **kwargs)
+        end
+
+        #
+        # @!macro connect_kwargs
+        #   @option kwargs [String] :bind_host
+        #     The local host to bind to.
+        #
+        #   @option kwargs [Integer] :bind_port
+        #     The local port to bind to.
+        #
+        #   @!macro context_kwargs
+        #
+
+        #
+        # 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 [1, 1.1, 1.2, 1.3, Symbol, nil] min_version
+        #   The minimum TLS version to use.
+        #
+        # @param [Hash{Symbol => Object}] kwargs
+        #   Additional keyword arguments for {SSL.connect}.
+        #
+        # @!macro connect_kwargs
+        #
+        # @return [Boolean, nil]
+        #   Specifies whether the remote SSLed TCP port is open.
+        #   If the connection was not accepted, `nil` will be returned.
+        #
+        # @example
+        #   tls_open?('www.bankofamerica.com',443)
+        #
+        # @example Using a timeout:
+        #   tls_open?('example.com',80, timeout: 5)
+        #   # => nil
+        #
+        # @api public
+        #
+        # @since 1.1.0
+        #
+        def self.open?(host,port, min_version: 1, **kwargs)
+          SSL.open?(host,port, min_version: min_version, **kwargs)
+        end
+
+        #
+        # Establishes a SSL connection.
+        #
+        # @param [String] host
+        #   The host to connect to.
+        #
+        # @param [Integer] port
+        #   The port to connect to.
+        #
+        # @param [1, 1.1, 1.2, 1.3, Symbol, nil] min_version
+        #   The minimum TLS version to use.
+        #
+        # @param [Hash{Symbol => Object}] kwargs
+        #   Additional keyword arguments for {socket}.
+        #
+        # @!macro connect_kwargs
+        #
+        # @yield [tls_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] tls_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 = tls_connect('twitter.com',443)
+        #
+        # @example
+        #   tls_connect('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
+        #
+        # @since 1.1.0
+        #
+        def self.connect(host,port, min_version: 1, **kwargs, &block)
+          SSL.connect(host,port, min_version: min_version, **kwargs, &block)
+        end
+
+        #
+        # 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 [1, 1.1, 1.2, 1.3, Symbol, nil] min_version
+        #   The minimum TLS version to use.
+        #
+        # @param [Hash{Symbol => Object}] kwargs
+        #   Additional keyword arguments for {connect}.
+        #
+        # @!macro connect_kwargs
+        #
+        # @yield [tls_socket]
+        #   The given block will be passed the newly created TLS Socket.
+        #
+        # @yieldparam [OpenSSL::SSL::SSLSocket] tls_socket
+        #   The newly created SSL Socket.
+        #
+        # @api public
+        #
+        # @since 1.1.0
+        #
+        def self.connect_and_send(data,host,port, min_version: 1, **kwargs, &block)
+          SSL.connect_and_send(data,host,port, min_version: min_version, **kwargs, &block)
+        end
+
+        #
+        # 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 [1, 1.1, 1.2, 1.3, Symbol, nil] min_version
+        #   The minimum TLS version to use.
+        #
+        # @param [Hash{Symbol => Object}] kwargs
+        #   Additional keyword arguments for {connect}.
+        #
+        # @!macro connect_kwargs
+        #
+        # @yield [tls_socket]
+        #   The given block will be passed the newly created SSL Socket.
+        #
+        # @return [OpenSSL::X509::Certificate]
+        #   The server's certificate.
+        #
+        # @since 1.1.0
+        #
+        def self.get_cert(host,port, min_version: 1, **kwargs)
+          SSL.get_cert(host,port, min_version: min_version, **kwargs)
+        end
+
+        #
+        # 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 [1, 1.1, 1.2, 1.3, Symbol, nil] min_version
+        #   The minimum TLS version to use.
+        #
+        # @param [Hash{Symbol => Object}] kwargs
+        #   Additional keyword arguments for {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
+        #   tls_banner('smtp.gmail.com',465)
+        #   # => "220 mx.google.com ESMTP c20sm3096959rvf.1"
+        #
+        # @api public
+        #
+        # @since 1.1.0
+        #
+        def self.banner(host,port, min_version: 1, **kwargs, &block)
+          SSL.banner(host,port, min_version: min_version, **kwargs, &block)
+        end
+
+        #
+        # 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 [1, 1.1, 1.2, 1.3, Symbol, nil] min_version
+        #   The minimum TLS version to use.
+        #
+        # @param [Hash{Symbol => Object}] kwargs
+        #   Additional keyword arguments for {connect}.
+        #
+        # @!macro connect_kwargs
+        #
+        # @return [true]
+        #   The data was successfully sent.
+        #
+        # @example
+        #   buffer = "GET /#{'A' * 4096}\n\r"
+        #   tls_send(buffer,'victim.com',443)
+        #   # => true
+        #
+        # @api public
+        #
+        # @since 1.1.0
+        #
+        def self.send(data,host,port, min_version: 1, **kwargs)
+          SSL.send(data,host,port, min_version: min_version, **kwargs)
+        end
+
+        #
+        # @!macro server_context_kwargs
+        #   @option kwargs [Crypto::Key::RSA, OpenSSL::PKey::RSA, nil] :key (SSL.key)
+        #     The RSA key to use for the TLS context.
+        #
+        #   @option kwargs [Crypto::Cert, OpenSSL::X509::Certificate, nil] :cert (SSL.cert)
+        #     The X509 certificate to use for the SSL context.
+        #
+        #   @!macro context_kwargs
+        #
+
+        #
+        # Accepts an TLS session from an existing TCP socket.
+        #
+        # @param [TCPSocket] socket
+        #   The existing TCP socket.
+        #
+        # @param [1, 1.1, 1.2, 1.3, Symbol, nil] min_version
+        #   The minimum TLS version to use.
+        #
+        # @param [Hash{Symbol => Object}] kwargs
+        #   Additional keyword arguments for {socket}.
+        #
+        # @!macro server_context_kwargs
+        #
+        # @return [OpenSSL::SSL::SSLSocket]
+        #   the new SSL Socket.
+        #
+        # @api public
+        #
+        # @since 1.1.0
+        #
+        def self.server_socket(socket, min_version: 1, **kwargs)
+          SSL.server_socket(socket, min_version: min_version, **kwargs)
+        end
+
+        #
+        # @!macro server_kwargs
+        #   @option kwargs [Integer] :port (0)
+        #     The local port to listen on.
+        #
+        #   @option kwargs [String, nil] :host
+        #     The host to bind to.
+        #
+        #   @option kwargs [Integer] :backlog (5)
+        #     The maximum backlog of pending connections.
+        #
+        #   @!macro server_context_kwargs
+        #
+
+        #
+        # Creates a new TLS server listening on a given host and port.
+        #
+        # @param [1, 1.1, 1.2, 1.3, Symbol, nil] min_version
+        #   The minimum TLS version to use.
+        #
+        # @param [Hash{Symbol => Object}] kwargs
+        #   Additional keyword arguments for {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
+        #
+        def self.server(min_version: 1, **kwargs, &block)
+          SSL.server(min_version: min_version, **kwargs, &block)
+        end
+
+        #
+        # Creates a new temporary TLS server listening on a given host and port.
+        #
+        # @param [1, 1.1, 1.2, 1.3, Symbol, nil] min_version
+        #   The minimum TLS version to use.
+        #
+        # @param [Hash{Symbol => Object}] kwargs
+        #   Additional keyword arguments for {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. Once the block has finished,
+        #   the server will be closed.
+        #
+        # @return [OpenSSL::SSL::SSLServer]
+        #   The newly created SSL server.
+        #
+        # @api public
+        #
+        # @since 1.1.0
+        #
+        def self.server_session(min_version: 1, **kwargs, &block)
+          SSL.server_session(min_version: min_version, **kwargs, &block)
+        end
+
+        #
+        # Creates a new SSL socket listening on a given host and port,
+        # accepting clients in a loop.
+        #
+        # @param [1, 1.1, 1.2, 1.3, Symbol, nil] min_version
+        #   The minimum TLS version to use.
+        #
+        # @param [Hash{Symbol => Object}] kwargs
+        #   Additional keyword arguments for {server_socket}.
+        #
+        # @!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
+        #   tls_server_loop(port: 1337, cert: 'ssl.crt', key: 'ssl.key') do |sock|
+        #     sock.puts 'lol'
+        #   end
+        #
+        # @api public
+        #
+        # @since 1.1.0
+        #
+        def self.server_loop(min_version: 1, **kwargs, &block)
+          SSL.server_loop(min_version: min_version, **kwargs, &block)
+        end
+
+        #
+        # Creates a new SSL socket listening on a given host and port,
+        # accepts only one client and then stops listening.
+        #
+        # @param [1, 1.1, 1.2, 1.3, Symbol, nil] min_version
+        #   The minimum TLS version to use.
+        #
+        # @param [Hash{Symbol => Object}] kwargs
+        #   Additional keyword arguments for {server_socket}.
+        #
+        # @!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
+        #   tls_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
+        #   tls_accept(port: 1337, cert: 'ssl.crt', key: 'ssl.key') do |client|
+        #     client.puts 'lol'
+        #   end
+        #
+        # @api public
+        #
+        # @since 1.1.0
+        #
+        def self.accept(min_version: 1, **kwargs, &block)
+          SSL.accept(min_version: min_version, **kwargs, &block)
         end
       end
     end

data/lib/ronin/support/network/udp/mixin.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2006-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-support is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published

data/lib/ronin/support/network/udp/proxy.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2006-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-support is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published

data/lib/ronin/support/network/udp.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2006-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-support is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published

data/lib/ronin/support/network/unix/mixin.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2006-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-support is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published

data/lib/ronin/support/network/wildcard.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+#
+# Copyright (c) 2006-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# ronin-support is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# ronin-support is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with ronin-support.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+require 'ronin/support/network/host'
+
+module Ronin
+  module Support
+    module Network
+      #
+      # Represents a wildcard hostname.
+      #
+      # ## Examples
+      #
+      #     wildcard = Network::Wildcard.new('*.example.com')
+      #     wildcard.subdomain('www')
+      #     # => #<Ronin::Support::Network::Host: www.example.com>
+      #
+      # @api public
+      #
+      # @since 1.1.0
+      #
+      class Wildcard
+
+        # The wildcard template for the hostname.
+        #
+        # @return [String]
+        attr_reader :template
+
+        #
+        # Initializes the wildcard hostname.
+        #
+        # @param [String] template
+        #   The wildcard hostname template.
+        #
+        # @example
+        #   wildcard = Network::Wildcard.new('*.example.com')
+        #
+        def initialize(template)
+          @template = template
+        end
+
+        #
+        # Replaces the `*` in the wildcard hostname with the given name.
+        #
+        # @param [String] name
+        #   The name to replace the `*` wildcard with.
+        #
+        # @return [Host]
+        #   The new hostname.
+        #
+        # @example
+        #   wildcard = Network::Wildcard.new('*.example.com')
+        #   wildcard.subdomain('www')
+        #   # => #<Ronin::Support::Network::Host: www.example.com>
+        #
+        def subdomain(name)
+          Host.new(@template.sub('*',name))
+        end
+
+        #
+        # Converts the wildcard hostname to a String.
+        #
+        # @return [String]
+        #   The string value of the wildcard hostname.
+        #
+        def to_s
+          @template
+        end
+
+      end
+    end
+  end
+end

data/lib/ronin/support/network.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2006-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-support is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published

data/lib/ronin/support/path.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2006-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-support is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published

data/lib/ronin/support/text/core_ext/regexp.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2006-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-support is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published

data/lib/ronin/support/text/core_ext/string.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2006-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-support is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published

data/lib/ronin/support/text/core_ext.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2006-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-support is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published