ronin-support 0.5.2 → 1.0.0.beta1

data/lib/ronin/network/http/proxy.rb

@@ -1,330 +0,0 @@
-#
-# Copyright (c) 2006-2021 Hal Brodigan (postmodern.mod3 at gmail.com)
-#
-# This file is part of ronin-support.
-#
-# 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/extensions/ip_addr'
-require 'ronin/network/network'
-
-module Ronin
-  module Network
-    module HTTP
-      #
-      # The {Proxy} class represents the information needed to connect
-      # to a HTTP Proxy. The {Proxy} class can also test the reliability
-      # of a HTTP proxy.
-      #
-      class Proxy < Struct.new(:host, :port, :user, :password)
-
-        #
-        # Creates a new Proxy object that represents a proxy to connect to.
-        #
-        # @param [Hash] options
-        #   Additional options for the proxy.
-        #
-        # @option options [String] :host
-        #   The host-name of the proxy.
-        #
-        # @option options [Integer] :port
-        #   The port that the proxy is running on.
-        #
-        # @option options [String] :user
-        #   The user-name to authenticate as.
-        #
-        # @option options [String] :password
-        #   The password to authenticate with.
-        #
-        # @api public
-        #
-        def initialize(options={})
-          super(
-            options[:host],
-            options[:port],
-            options[:user],
-            options[:password]
-          )
-        end
-
-        #
-        # Parses a proxy URL.
-        #
-        # @param [String, URI::HTTP] proxy
-        #   The proxy URL in String form.
-        #
-        # @return [Proxy]
-        #   The parsed proxy information.
-        #
-        # @example
-        #   Proxy.parse('217.31.51.77:443')
-        #
-        # @example
-        #   Proxy.parse('joe:lol@127.0.0.1:8080')
-        #
-        # @example
-        #   Proxy.parse('http://201.26.192.61:8080')
-        #
-        # @api public
-        #
-        def self.parse(proxy)
-          proxy = proxy.to_s.gsub(/^http(s)?:\/*/,'')
-
-          if proxy.include?('@')
-            auth, proxy = proxy.split('@',2)
-            user, password = auth.split(':')
-          else
-            user = nil
-            password = nil
-          end
-
-          host, port = proxy.split(':',2)
-          port = port.to_i if port
-
-          return new(
-            :host => host,
-            :port => port,
-            :user => user,
-            :password => password
-          )
-        end
-
-        #
-        # Creates a new proxy.
-        #
-        # @param [Proxy, URI::HTTP, Hash, String] proxy
-        #   The proxy information.
-        #
-        # @return [Proxy]
-        #   The new proxy.
-        #
-        # @raise [ArgumentError]
-        #   The given proxy information was not a {Proxy}, `URI::HTTP`,
-        #   `Hash` or {String}.
-        #
-        # @api public
-        #
-        def self.create(proxy)
-          case proxy
-          when Proxy
-            proxy
-          when URI::HTTP
-            new(
-              :host => proxy.host,
-              :port => proxy.port,
-              :user => proxy.user,
-              :password => proxy.password
-            )
-          when Hash
-            new(proxy)
-          when String
-            parse(proxy)
-          when nil
-            new
-          else
-            raise(ArgumentError,"argument must be either a #{self}, URI::HTTP, Hash or String")
-          end
-        end
-
-        #
-        # Tests the proxy.
-        #
-        # @return [Boolean]
-        #   Specifies if the proxy can proxy requests.
-        #
-        # @api public
-        #
-        def valid?
-          begin
-            Net.http_get_body(
-              :url => 'http://www.example.com/',
-              :proxy => self
-            ).include?('Example Web Page')
-          rescue Timeout::Error, StandardError
-            return false
-          end
-        end
-
-        #
-        # Measures the latency of the proxy.
-        #
-        # @return [Float]
-        #   The extra number of seconds it takes the proxy to process the
-        #   request, compared to sending the request directly.
-        #
-        # @api public
-        #
-        def latency
-          time = lambda { |proxy|
-            t1 = Time.now
-            Net.http_head(
-              :url => 'http://www.example.com/',
-              :proxy => proxy
-            )
-            t2 = Time.now
-
-            (t2 - t1)
-          }
-
-          begin
-            return (time.call(self) - time.call(nil))
-          rescue Timeout::Error, StandardError
-            return (1.0/0)
-          end
-        end
-
-        alias lag latency
-
-        #
-        # The IP address the proxy sends with proxied requests.
-        #
-        # @return [String]
-        #   The IP address the proxy uses for our requests.
-        #
-        # @api public
-        #
-        def proxied_ip
-          IPAddr.extract(Net.http_get_body(
-            :url => Network::IP_URL,
-            :proxy => self
-          )).first
-        end
-
-        #
-        # Determines whether the proxy forwards our IP address.
-        #
-        # @return [Boolean]
-        #   Specifies whether the proxy will forward our IP address.
-        #
-        # @api public
-        #
-        def transparent?
-          Network.ip == proxied_ip
-        end
-
-        #
-        # Determines whether the proxy will hide our IP address.
-        #
-        # @return [Boolean]
-        #   Specifies whether the proxy will hide our IP address.
-        #
-        # @api public
-        #
-        def anonymous?
-          !(transparent?)
-        end
-
-        #
-        # Disables the Proxy object.
-        #
-        # @api public
-        #
-        def disable!
-          self.host = nil
-          self.port = nil
-          self.user = nil
-          self.password = nil
-
-          return self
-        end
-
-        #
-        # Specifies whether the proxy object is usable.
-        #
-        # @return [Boolean]
-        #   Specifies whether the proxy object is usable by
-        #   Net::HTTP::Proxy.
-        #
-        # @api public
-        #
-        def enabled?
-          !(host.nil?)
-        end
-
-        #
-        # Builds a HTTP URI from the proxy information.
-        #
-        # @return [URI::HTTP, nil]
-        #   The HTTP URI representing the proxy. If the proxy is disabled,
-        #   then `nil` will be returned.
-        #
-        # @api public
-        #
-        def url
-          return nil unless enabled?
-
-          userinfo = if user
-                       if password
-                         "#{user}:#{password}"
-                       else
-                         user
-                       end
-                     end
-          
-          return URI::HTTP.build(
-            :userinfo => userinfo,
-            :host => host,
-            :port => port
-          )
-        end
-
-        #
-        # Converts the proxy object to a String.
-        #
-        # @return [String]
-        #   The host-name of the proxy.
-        #
-        # @api public
-        #
-        def to_s
-          host.to_s
-        end
-
-        #
-        # Inspects the proxy object.
-        #
-        # @return [String]
-        #   The inspection of the proxy object.
-        #
-        # @api public
-        #
-        def inspect
-          unless host
-            str = 'disabled'
-          else
-            str = ''
-            
-            str << host.to_s
-            str << ":#{port}" if port
-
-            if user
-              auth_str = ''
-              auth_str << user.to_s
-
-              if password
-                auth_str << ":#{password}"
-              end
-
-              str = "#{auth_str}@#{str}"
-            end
-          end
-
-          return "#<#{self.class}: #{str}>"
-        end
-
-      end
-    end
-  end
-end

data/lib/ronin/network/http.rb

@@ -1,22 +0,0 @@
-#
-# Copyright (c) 2006-2021 Hal Brodigan (postmodern.mod3 at gmail.com)
-#
-# This file is part of ronin-support.
-#
-# 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/network/http/exceptions'
-require 'ronin/network/http/http'
-require 'ronin/network/extensions/http'

data/lib/ronin/network/imap.rb

@@ -1,158 +0,0 @@
-#
-# Copyright (c) 2006-2021 Hal Brodigan (postmodern.mod3 at gmail.com)
-#
-# This file is part of ronin-support.
-#
-# 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/network/ssl'
-
-require 'net/imap'
-
-module Ronin
-  module Network
-    #
-    # Provides helper methods for communicating with IMAP services.
-    #
-    module IMAP
-      # Default IMAP port
-      DEFAULT_PORT = 143
-
-      #
-      # @return [Integer]
-      #   The default Ronin IMAP port.
-      #
-      # @api public
-      #
-      def self.default_port
-        @default_port ||= DEFAULT_PORT
-      end
-
-      #
-      # Sets the default Ronin IMAP port.
-      #
-      # @param [Integer] port
-      #   The new default Ronin IMAP port.
-      #
-      # @api public
-      #
-      def self.default_port=(port)
-        @default_port = port
-      end
-
-      #
-      # Creates a connection to the IMAP server.
-      #
-      # @param [String] host
-      #   The host to connect to.
-      #
-      # @param [Hash] options
-      #   Additional options.
-      #
-      # @option options [Integer] :port (IMAP.default_port)
-      #   The port the IMAP server is running on.
-      #
-      # @option options [String] :certs
-      #   The path to the file containing CA certs of the server.
-      #
-      # @option options [Symbol] :auth
-      #   The type of authentication to perform when connecting to the server.
-      #   May be either `:login` or `:cram_md5`.
-      #
-      # @option options [String] :user
-      #   The user to authenticate as when connecting to the server.
-      #
-      # @option options [String] :password
-      #   The password to authenticate with when connecting to the server.
-      #
-      # @yield [session]
-      #   If a block is given, it will be passed the newly created IMAP
-      #   session.
-      #
-      # @yieldparam [Net::IMAP] session
-      #   The newly created IMAP session object.
-      #
-      # @return [Net::IMAP]
-      #   The newly created IMAP session object.
-      #
-      # @api public
-      #
-      def imap_connect(host,options={})
-        host   = host.to_s
-        port   = (options[:port] || IMAP.default_port)
-        certs  = options[:certs]
-        auth   = options[:auth]
-        user   = options[:user]
-        passwd = options[:password]
-
-        if options[:ssl]
-          ssl        = true
-          ssl_certs  = options[:ssl][:certs]
-          ssl_verify = SSL::VERIFY[options[:ssl][:verify]]
-        else
-          ssl        = false
-          ssl_certs  = nil
-          ssl_verify = false
-        end
-
-        session = Net::IMAP.new(host,port,ssl,ssl_certs,ssl_verify)
-
-        if user
-          if auth == :cram_md5
-            session.authenticate('CRAM-MD5',user,passwd)
-          else
-            session.authenticate('LOGIN',user,passwd)
-          end
-        end
-
-        yield session if block_given?
-        return session
-      end
-
-      #
-      # Starts an IMAP session with the IMAP server.
-      #
-      # @param [String] host
-      #   The host to connect to.
-      #
-      # @param [Hash] options
-      #   Additional options.
-      #
-      # @yield [session]
-      #   If a block is given, it will be passed the newly created IMAP
-      #   session. After the block has returned, the session will be closed.
-      #
-      # @yieldparam [Net::IMAP] session
-      #   The newly created IMAP session object.
-      #
-      # @return [nil]
-      #
-      # @see imap_connect
-      #
-      # @api public
-      #
-      def imap_session(host,options={})
-        session = imap_connect(host,options)
-
-        yield session if block_given?
-
-        session.logout if options[:user]
-        session.close
-        session.disconnect
-        return nil
-      end
-    end
-  end
-end

data/lib/ronin/network/mixins/esmtp.rb

@@ -1,164 +0,0 @@
-#
-# Copyright (c) 2006-2021 Hal Brodigan (postmodern.mod3 at gmail.com)
-#
-# This file is part of ronin-support.
-#
-# 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/network/mixins/mixin'
-require 'ronin/network/esmtp'
-
-module Ronin
-  module Network
-    module Mixins
-      #
-      # Adds ESMTP convenience methods and connection parameters to a class.
-      #
-      # Defines the following parameters:
-      #
-      # * `host` (`String`) - ESMTP host.
-      # * `port` (`Integer`) - ESMTP port.
-      # * `esmtp_login` (`String`) - ESMTP authentication method to use.
-      # * `esmtp_user` (`String`) - ESMTP user to login as.
-      # * `esmtp_password` (`String`) - ESMTP password to login with.
-      #
-      module ESMTP
-        include Mixin, Network::ESMTP
-
-        # ESMTP host
-        parameter :host, :type => String,
-                         :description => 'ESMTP host'
-
-        # ESMTP port
-        parameter :port, :type => Integer,
-                         :description => 'ESMTP port'
-
-        # ESMTP authentication method to use
-        parameter :esmtp_login, :type => String,
-                                :description => 'ESMTP authentication method to use'
-
-        # ESMTP user to login as
-        parameter :esmtp_user, :type => String,
-                               :description => 'ESMTP user to login as'
-
-        # ESMTP password to login with
-        parameter :esmtp_password, :type => String,
-                                   :description => 'ESMTP password to login with'
-
-        protected
-
-        #
-        # Creates a connection to the ESMTP server. The `host`, `port`,
-        # `esmtp_login`, `esmtp_user` and `esmtp_password` parameters
-        # will also be used to connect to the ESMTP server.
-        #
-        # @param [Hash] options
-        #   Additional options.
-        #
-        # @option options [Integer] :port (Ronin::Network::SMTP.default_port)
-        #  The port to connect to.
-        #
-        # @option options [String] :helo
-        #   The HELO domain.
-        #
-        # @option options [Symbol] :auth
-        #   The type of authentication to use.
-        #   Can be either `:login`, `:plain`, or `:cram_md5`.
-        #
-        # @option options [String] :user
-        #   The user-name to authenticate with.
-        #
-        # @option options [String] :password
-        #   The password to authenticate with.
-        #
-        # @yield [session]
-        #   If a block is given, it will be passed an ESMTP enabled
-        #   session object.
-        #
-        # @yieldparam [Net::SMTP] session
-        #   The ESMTP session.
-        #
-        # @return [Net::SMTP]
-        #   The ESMTP enabled session.
-        #
-        # @see Network::ESMTP#esmtp_connect
-        #
-        # @api public
-        #
-        def esmtp_connect(options={},&block)
-          print_info "Connecting to #{host_port} ..."
-
-          return super(self.host,esmtp_merge_options(options),&block)
-        end
-
-        #
-        # Starts a session with the ESMTP server. The `host`, `port`,
-        # `esmtp_login`, `esmtp_user` and `esmtp_password` parameters
-        # will also be used to connect to the ESMTP server.
-        #
-        # @param [Hash] options
-        #   Additional options.
-        #
-        # @yield [session]
-        #   If a block is given, it will be passed an ESMTP enabled
-        #   session object. After the block has returned, the session
-        #   will be closed.
-        #
-        # @yieldparam [Net::SMTP] session
-        #   The ESMTP session.
-        #
-        # @see Network::ESMTP#esmtp_session
-        #
-        # @api public
-        #
-        def esmtp_session(options={})
-          super(esmtp_merge_options(options)) do |sess|
-            yield sess if block_given?
-
-            print_info "Logging out ..."
-          end
-
-          print_info "Disconnected from #{host_port}"
-          return nil
-        end
-
-        private
-
-        #
-        # Merges the ESMTP parameters into the options for {Network::ESMTP}
-        # methods.
-        #
-        # @param [Hash] options
-        #   The original options.
-        #
-        # @return [Hash]
-        #   The merged options.
-        #
-        # @since 0.4.0
-        #
-        # @api private
-        #   
-        def esmtp_merge_options(options={})
-          options[:port]     ||= self.port
-          options[:login]    ||= self.esmtp_login
-          options[:user]     ||= self.esmtp_user
-          options[:password] ||= self.esmtp_password
-
-          return options
-        end
-      end
-    end
-  end
-end