ronin-support 0.5.2 → 1.0.0.beta1

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

@@ -1,155 +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/ftp'
-
-module Ronin
-  module Network
-    module Mixins
-      #
-      # Adds FTP convenience methods and connection parameters to a class.
-      #
-      # Defines the following parameters:
-      #
-      # * `host` (`String`) - FTP host.
-      # * `port` (`Integer`) - FTP port.
-      # * `ftp_user` (`String`) - FTP user to login as.
-      # * `ftp_password` (`String`) - FTP password to login with.
-      # * `ftp_account` (`String`) - FTP account information to send.
-      #
-      # @since 0.5.0
-      #
-      module FTP
-        include Mixin, Network::FTP
-
-        # FTP host
-        parameter :host, :type => String,
-                         :description => 'FTP host'
-
-        # FTP port
-        parameter :port, :type => Integer,
-                         :description => 'FTP port'
-
-        # FTP user to login as
-        parameter :ftp_user, :type => String,
-                              :description => 'FTP user to login as'
-
-        # FTP password to login with
-        parameter :ftp_password, :type => String,
-                                  :description => 'FTP password to login with'
-
-        # FTP account information to send
-        parameter :ftp_password, :type => String,
-                                  :description => 'FTP account information'
-
-        protected
-
-        #
-        # Creates a connection to the FTP server. The `host`, `port`,
-        # `ftp_user`, `ftp_password` and `ftp_account` parameters
-        # will also be used to connect to the server.
-        #
-        # @param [Hash] options
-        #   Additional options.
-        #
-        # @option options [Integer] :port (Network::FTP.default_port)
-        #   The port to connect to.
-        #
-        # @option options [String] :user
-        #   The username to authenticate with.
-        #
-        # @option options [String] :password
-        #   The password to authenticate with.
-        #
-        # @option options [String] :account
-        #   The account information to send via the FTP `ACCT` command.
-        #
-        # @yield [session]
-        #   If a block is given, it will be passed an FTP session object.
-        #
-        # @yieldparam [Net::FTP] session
-        #   The FTP session.
-        #
-        # @return [Net::FTP]
-        #   The FTP session.
-        #
-        # @see Network::FTP#ftp_connect
-        #
-        # @api public
-        #
-        def ftp_connect(options={},&block)
-          print_info "Connecting to #{host_port} ..."
-
-          return super(self.host,ftp_merge_options(options),&block)
-        end
-
-        #
-        # Starts a session with the FTP server. The `host`, `port`,
-        # `ftp_login`, `ftp_user` and `ftp_password` parameters
-        # will also be used to connect to the server.
-        #
-        # @yield [session]
-        #   If a block is given, it will be passed an FTP session object.
-        #   After the block has returned, the session will be closed.
-        #
-        # @yieldparam [Net::FTP] session
-        #   The FTP session.
-        #
-        # @see Network::FTP#ftp_session
-        #
-        # @api public
-        #
-        def ftp_session(options={},&block)
-          super(ftp_merge_options(options)) do |sess|
-            yield sess if block_given?
-
-            print_info "Logging out ..."
-          end
-
-          print_info "Disconnected to #{host_port}"
-          return nil
-        end
-
-        private
-
-        #
-        # Merges the FTP parameters into the options for {Network::FTP}
-        # methods.
-        #
-        # @param [Hash] options
-        #   The original options.
-        #
-        # @return [Hash]
-        #   The merged options.
-        #
-        # @api private
-        #   
-        def ftp_merge_options(options={})
-          options[:port]     ||= self.port
-          options[:user]     ||= self.ftp_user
-          options[:password] ||= self.ftp_password
-          options[:account]  ||= self.ftp_account
-
-          return options
-        end
-      end
-    end
-  end
-end

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

@@ -1,227 +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/http'
-
-module Ronin
-  module Network
-    module Mixins
-      #
-      # Adds HTTP convenience methods and connection parameters to a class.
-      #
-      # Defines the following parameters:
-      #
-      # * `host` (`String`) - HTTP host.
-      # * `port` (`Integer`) - HTTP port. Defaults to `Net::HTTP.default_port`.
-      # * `http_vhost` (`String`) - HTTP Host header to send.
-      # * `http_user` (`String`) - HTTP user to authenticate as.
-      # * `http_password` (`String`) - HTTP password to authenticate with.
-      # * `http_proxy` - HTTP proxy information.
-      # * `http_user_agent` (`String`) - HTTP User-Agent header to send.
-      #
-      module HTTP
-        include Mixin, Network::HTTP
-
-        # HTTP host
-        parameter :host, :type => String,
-                         :description => 'HTTP host'
-
-        # HTTP port
-        parameter :port, :default => Net::HTTP.default_port,
-                         :description => 'HTTP port'
-
-        # HTTP `Host` header to send
-        parameter :http_vhost, :type => String,
-                               :description => 'HTTP Host header to send'
-
-        # HTTP user to authenticate as
-        parameter :http_user, :type => String,
-                              :description => 'HTTP user to authenticate as'
-
-        # HTTP password to authenticate with
-        parameter :http_password, :type => String,
-                                  :description => 'HTTP password to authenticate with'
-
-        # HTTP proxy information
-        parameter :http_proxy, :description => 'HTTP proxy information'
-
-        # HTTP `User-Agent` header to send
-        parameter :http_user_agent, :type => String,
-                                    :description => 'HTTP User-Agent header to send'
-
-        protected
-
-        #
-        # Resets the HTTP proxy settings.
-        #
-        # @api public
-        #
-        def disable_http_proxy
-          @http_proxy = nil
-        end
-
-        #
-        # Starts a HTTP connection with the server.
-        #
-        # @param [Hash] options
-        #   Additional options
-        #
-        # @option options [String, URI::HTTP] :url
-        #   The full URL to request.
-        #
-        # @option options [String] :host
-        #   The host the HTTP server is running on.
-        #
-        # @option options [Integer] :port (Net::HTTP.default_port)
-        #   The port the HTTP server is listening on.
-        #
-        # @option options [String, Hash] :proxy (HTTP.proxy)
-        #   A Hash of proxy settings to use when connecting to the HTTP server.
-        #
-        # @option options [String] :user
-        #   The user to authenticate with when connecting to the HTTP server.
-        #
-        # @option options [String] :password
-        #   The password to authenticate with when connecting to the HTTP
-        #   server.
-        #
-        # @option options [Boolean, Hash] :ssl
-        #   Enables SSL for the HTTP connection.
-        #
-        # @option :ssl [Symbol] :verify
-        #   Specifies the SSL certificate verification mode.
-        #   
-        # @yield [http]
-        #   If a block is given, it will be passed the newly created HTTP
-        #   session object.
-        #
-        # @yieldparam [Net::HTTP] http
-        #   The newly created HTTP session.
-        #
-        # @return [Net::HTTP]
-        #   The HTTP session object.
-        #
-        # @see Network::HTTP#http_connect
-        #
-        # @api public
-        #
-        # @since 0.5.0
-        #
-        def http_connect(options={},&block)
-          super(http_merge_options(options),&block)
-        end
-
-        #
-        # Connects to the HTTP server and sends an HTTP Request.
-        #
-        # @param [Hash] options
-        #   Additional options.
-        #
-        # @option options [Hash{String,Symbol => Object}] :headers
-        #   The Hash of the HTTP headers to send with the request.
-        #   May contain either Strings or Symbols, lower-case or
-        #   camel-case keys.
-        #
-        # @yield [request, (options)]
-        #   If a block is given, it will be passed the HTTP request object.
-        #   If the block has an arity of 2, it will also be passed the
-        #   expanded version of the given options.
-        #
-        # @yieldparam [Net::HTTPRequest] request
-        #   The HTTP request object to use in the request.
-        #
-        # @yieldparam [Hash] options
-        #   The expanded version of the given options.
-        #
-        # @return [Net::HTTPResponse]
-        #   The response of the HTTP request.
-        #
-        # @see Network::HTTP#http_request
-        #
-        # @api public
-        #
-        def http_request(options={},&block)
-          response = super(options) do |request,expanded_options|
-            if block
-              if block.arity == 2
-                block.call(request,expanded_options)
-              else
-                block.call(request)
-              end
-            end
-
-            host = options.fetch(:host,self.host)
-            port = options.fetch(:port,self.port)
-
-            print_info "HTTP #{request.method} #{host}:#{port} #{request.path}"
-
-            request.each_capitalized do |name,value|
-              print_debug "  #{name}: #{value}"
-            end
-          end
-
-          print_info "HTTP #{response.code} #{response.message}"
-
-          response.each_capitalized do |name,value|
-            print_debug "  #{name}: #{value}"
-          end
-
-          return response
-        end
-
-        private
-
-        #
-        # Merges the HTTP parameters into the HTTP options.
-        #
-        # @param [Hash] options
-        #   The HTTP options to merge into.
-        #
-        # @return [Hash]
-        #   The merged HTTP options.
-        #
-        # @since 1.0.0
-        #
-        # @api private
-        #
-        def http_merge_options(options={})
-          options = options.dup
-
-          options[:proxy] ||= self.http_proxy if self.http_proxy
-          options[:host]  ||= self.host       if self.host
-          options[:port]  ||= self.port       if self.port
-
-          if (self.http_vhost || self.http_user_agent)
-            headers = (options[:headers] ||= {})
-
-            headers[:host]       ||= self.http_vhost      if self.http_vhost
-            headers[:user_agent] ||= self.http_user_agent if self.http_user_agent
-          end
-
-          options[:user]     ||= self.http_user     if self.http_user
-          options[:password] ||= self.http_password if self.http_password
-
-          return options
-        end
-
-      end
-    end
-  end
-end

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

@@ -1,156 +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/imap'
-
-module Ronin
-  module Network
-    module Mixins
-      #
-      # Adds IMAP convenience methods and connection parameters to a class.
-      #
-      # Defines the following parameters:
-      #
-      # * `host` (`String`) - IMAP host.
-      # * `port` (`Integer`) - IMAP port.
-      # * `imap_auth` (`String`) - IMAP authentication method.
-      # * `imap_user` (`String`) - IMAP user to login as.
-      # * `imap_password` (`String`) - IMAP password to login with.
-      #
-      module IMAP
-        include Mixin, Network::IMAP
-
-        # IMAP host
-        parameter :host, :type => String,
-                         :description => 'IMAP host'
-
-        # IMAP port
-        parameter :port, :type => Integer,
-                         :description => 'IMAP port'
-
-        # IMAP auth
-        parameter :imap_auth, :type => String,
-                              :description => 'IMAP authentication method'
-
-        # IMAP user to login as
-        parameter :imap_user, :type => String,
-                              :description => 'IMAP user to login as'
-
-        # IMAP password to login with
-        parameter :imap_password, :type => String,
-                                  :description => 'IMAP password to login with'
-
-        protected
-
-        #
-        # Creates a connection to the IMAP server. The `host`, `port`,
-        # `imap_auth`, `imap_user` and `imap_password` parameters
-        # will also be used to make the connection.
-        #
-        # @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.
-        #
-        # @option options [Boolean]
-        #   Indicates wether or not to use SSL when connecting to the
-        #   server.
-        #
-        # @see Network::IMAP#imap_connect
-        #
-        # @api public
-        #
-        def imap_connect(options={},&block)
-          print_info "Connecting to #{host_port} ..."
-
-          return super(self.host,imap_merge_options(options),&block)
-        end
-
-        #
-        # Starts a session with the IMAP server. The `host`, `port`,
-        # `imap_auth`, `imap_user` and `imap_password` parameters
-        # will also be used to make the connection.
-        #
-        # @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.
-        #
-        # @see Network::IMAP#imap_session
-        #
-        # @api public
-        #
-        def imap_session(options={})
-          super(imap_merge_options(options)) do |sess|
-            yield sess if block_given?
-
-            print_info "Logging out ..."
-          end
-
-          print_info "Disconnected from #{host_port}"
-          return il
-        end
-
-        private
-
-        #
-        # Merges the IMAP parameters into the options for {Network::IMAP}
-        # methods.
-        #
-        # @param [Hash] options
-        #   The original options.
-        #
-        # @return [Hash]
-        #   The merged options.
-        #
-        # @since 0.4.0
-        #
-        # @api private
-        #   
-        def imap_merge_options(options={})
-          options[:port]     ||= self.port
-          options[:auth]     ||= self.imap_auth
-          options[:user]     ||= self.imap_user
-          options[:password] ||= self.imap_password
-
-          return options
-        end
-      end
-    end
-  end
-end

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

@@ -1,149 +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/pop3'
-
-module Ronin
-  module Network
-    module Mixins
-      #
-      # Adds POP3 convenience methods and connection parameters to a class.
-      #
-      # Defines the following parameters:
-      #
-      # * `host` (`String`) - POP3 host.
-      # * `port` (`Integer`) - POP3 port.
-      # * `pop3_user` (`String`) - POP3 user to login as.
-      # * `pop3_password` (`String`) - POP3 password to login with.
-      #
-      module POP3
-        include Mixin, Network::POP3
-
-        # POP3 host
-        parameter :host, :type => String,
-                         :description => 'POP3 host'
-
-        # POP3 port
-        parameter :port, :type => Integer,
-                         :description => 'POP3 port'
-
-        # POP3 user
-        parameter :pop3_user, :type => String,
-                              :description => 'POP3 user to login as'
-
-        # POP3 password
-        parameter :pop3_password, :type => String,
-                                  :description => 'POP3 password to login with'
-
-        protected
-
-        #
-        # Creates a connection to the POP3 server. The `host}, `port`,
-        # `pop3_user` and `pop3_password` parameters will also be used
-        # to connect to the server.
-        #
-        # @param [Hash] options
-        #   Additional options.
-        #
-        # @option options [Integer] :port (Ronin::Network::POP3.default_port)
-        #   The port the POP3 server is running on.
-        #
-        # @option options [String] :user
-        #   The user to authenticate with when connecting to the POP3
-        #   server.
-        #
-        # @option options [String] :password
-        #   The password to authenticate with when connecting to the POP3
-        #   server.
-        #
-        # @yield [session]
-        #   If a block is given, it will be passed the newly created
-        #   POP3 session.
-        #
-        # @yieldparam [Net::POP3] session
-        #   The newly created POP3 session.
-        #
-        # @return [Net::POP3]
-        #   The newly created POP3 session.
-        #
-        # @see Network::POP3#pop3_connect
-        #
-        # @api public
-        #
-        def pop3_connect(options={},&block)
-          print_info "Connecting to #{host_port} ..."
-
-          return super(self.host,pop3_merge_options(options),&block)
-        end
-
-        #
-        # Starts a session with the POP3 server. The `host`, `port`,
-        # `pop3_user` and `pop3_password` parameters will also be used
-        # to connect to the server.
-        #
-        # @yield [session]
-        #   If a block is given, it will be passed the newly created
-        #   POP3 session. After the block has returned, the session
-        #   will be closed.
-        #
-        # @yieldparam [Net::POP3] session
-        #   The newly created POP3 session.
-        #
-        # @see Network::POP3#pop3_session
-        #
-        # @api public
-        #
-        def pop3_session(options={})
-          super(options) do |sess|
-            yield sess if block_given?
-
-            print_info "Logging out ..."
-          end
-
-          print_info "Disconnected to #{host_port}"
-        end
-
-        private
-
-        #
-        # Merges the POP3 parameters into the options for {Network::POP3}
-        # methods.
-        #
-        # @param [Hash] options
-        #   The original options.
-        #
-        # @return [Hash]
-        #   The merged options.
-        #
-        # @since 0.4.0
-        #
-        # @api private
-        #   
-        def pop3_merge_options(options={})
-          options[:port]     ||= self.port
-          options[:user]     ||= self.pop3_user
-          options[:password] ||= self.pop3_password
-
-          return options
-        end
-      end
-    end
-  end
-end