ronin-support 0.5.1 → 1.0.0.beta1

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

@@ -1,58 +0,0 @@
-#
-# Copyright (c) 2006-2012 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 <http://www.gnu.org/licenses/>.
-#
-
-require 'ronin/ui/output/helpers'
-
-require 'parameters'
-
-module Ronin
-  module Network
-    module Mixins
-      #
-      # @since 0.4.0
-      #
-      module Mixin
-        include Parameters,
-                UI::Output::Helpers
-
-        parameter :host, :type => String
-
-        parameter :port, :type => Integer
-
-        protected
-
-        #
-        # The host/port parameters.
-        #
-        # @return [String]
-        #   The host/port parameters in String form.
-        #
-        # @api semipublic
-        #
-        def host_port
-          if self.port
-            "#{self.host}:#{self.port}"
-          else
-            "#{self.host}"
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,149 +0,0 @@
-#
-# Copyright (c) 2006-2012 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 <http://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

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

@@ -1,159 +0,0 @@
-#
-# Copyright (c) 2006-2012 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 <http://www.gnu.org/licenses/>.
-#
-
-require 'ronin/network/mixins/mixin'
-require 'ronin/network/smtp'
-
-module Ronin
-  module Network
-    module Mixins
-      #
-      # Adds SMTP convenience methods and connection parameters to a class.
-      #
-      # Defines the following parameters:
-      #
-      # * `host` (`String`) - SMTP host.
-      # * `port` (`Integer`) - SMTP port.
-      # * `smtp_login` (`String`) - SMTP authentication method.
-      # * `smtp_user` (`String`) - SMTP user to login as.
-      # * `smtp_password` (`String`) - SMTP password to login with.
-      #
-      module SMTP
-        include Mixin, Network::SMTP
-
-        # SMTP host
-        parameter :host, :type => String,
-                         :description => 'SMTP host'
-
-        # SMTP port
-        parameter :port, :type => Integer,
-                         :description => 'SMTP port'
-
-        # SMTP authentication method
-        parameter :smtp_login, :type => String,
-                               :description => 'SMTP authentication method'
-
-        # SMTP user to login as
-        parameter :smtp_user, :type => String,
-                              :description => 'SMTP user to login as'
-
-        # SMTP user to login with
-        parameter :smtp_password, :type => String,
-                                  :description => 'SMTP password to login with'
-
-        protected
-
-        #
-        # Creates a connection to the SMTP server. The `host`, `port`,
-        # `smtp_login`, `smtp_user` and `smtp_password` parameters
-        # will also be used to connect to the 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 SMTP session object.
-        #
-        # @yieldparam [Net::SMTP] session
-        #   The SMTP session.
-        #
-        # @return [Net::SMTP]
-        #   The SMTP session.
-        #
-        # @see Network::SMTP#smtp_connect
-        #
-        # @api public
-        #
-        def smtp_connect(options={},&block)
-          print_info "Connecting to #{host_port} ..."
-
-          return super(self.host,smtp_merge_options(options),&block)
-        end
-
-        #
-        # Starts a session with the SMTP server. The `host`, `port`,
-        # `smtp_login`, `smtp_user` and `smtp_password` parameters
-        # will also be used to connect to the server.
-        #
-        # @yield [session]
-        #   If a block is given, it will be passed an SMTP session object.
-        #   After the block has returned, the session will be closed.
-        #
-        # @yieldparam [Net::SMTP] session
-        #   The SMTP session.
-        #
-        # @see Network::SMTP#smtp_session
-        #
-        # @api public
-        #
-        def smtp_session(options={},&block)
-          super(smtp_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 SMTP parameters into the options for {Network::SMTP}
-        # methods.
-        #
-        # @param [Hash] options
-        #   The original options.
-        #
-        # @return [Hash]
-        #   The merged options.
-        #
-        # @since 0.4.0
-        #
-        # @api private
-        #   
-        def smtp_merge_options(options={})
-          options[:port]     ||= self.port
-          options[:login]    ||= self.smtp_login
-          options[:user]     ||= self.smtp_user
-          options[:password] ||= self.smtp_password
-
-          return options
-        end
-      end
-    end
-  end
-end

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

@@ -1,148 +0,0 @@
-#
-# Copyright (c) 2006-2012 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 <http://www.gnu.org/licenses/>.
-#
-
-require 'ronin/network/mixins/mixin'
-require 'ronin/network/ssl'
-
-module Ronin
-  module Network
-    module Mixins
-      #
-      # Adds SSL convenience methods and connection parameters to a class.
-      #
-      # Defines the following parameters:
-      #
-      # * `host` (`String`) - SSL host.
-      # * `port` (`Integer`) - SSL port.
-      # * `local_host` (`String`) - SSL local host.
-      # * `local_port` (`Integer`) - SSL local port.
-      #
-      # @since 0.4.0
-      #
-      module SSL
-        include Mixin, Network::SSL
-
-        # SSL host
-        parameter :host, :type => String,
-                         :description => 'SSL host'
-
-        # SSL port
-        parameter :port, :type => Integer,
-                         :description => 'SSL port'
-
-        # SSL local host
-        parameter :local_host, :type => String,
-                               :description => 'SSL local host'
-
-        # SSL local port
-        parameter :local_port, :type => Integer,
-                               :description => 'SSL local port'
-
-        protected
-
-        #
-        # Establishes a SSL connection.
-        #
-        # @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
-        #
-        # @see Network::SSL#ssl_connect
-        #
-        # @api public
-        #
-        def ssl_connect(host,port,options={},&block)
-          options = options.merge(
-            :local_host => self.local_host,
-            :local_port => self.local_port
-          )
-
-          super(self.host,self.port,options,&block)
-        end
-
-        #
-        # Creates a new temporary SSL connection.
-        #
-        # @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 do |socket|
-        #     socket.write("GET / HTTP/1.1\n\r\n\r")
-        #
-        #     socket.each_line { |line| puts line }
-        #   end
-        #
-        # @see Network::SSL#ssl_session
-        #
-        # @api public
-        #
-        def ssl_session(options={},&block)
-          super(self.host,self.port,options,&block)
-        end
-      end
-    end
-  end
-end