ronin-support 0.2.0 → 0.3.0

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

@@ -0,0 +1,151 @@
+#
+# Copyright (c) 2006-2011 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/imap'
+require 'ronin/ui/output/helpers'
+require 'ronin/mixin'
+
+require 'parameters'
+
+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
+
+        mixin UI::Output::Helpers, Parameters
+
+        mixin do
+          # 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'
+        end
+
+        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.
+        #
+        # @api public
+        #
+        def imap_connect(options={},&block)
+          options[:port] ||= self.port
+          options[:auth] ||= self.imap_auth
+          options[:user] ||= self.imap_user
+          options[:password] ||= self.imap_password
+
+          if self.port
+            print_info "Connecting to #{self.host}:#{self.port} ..."
+          else
+            print_info "Connecting to #{self.host} ..."
+          end
+
+          return ::Net.imap_connect(self.host,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 imap_connect
+        #
+        # @api public
+        #
+        def imap_session(options={})
+          imap_connect(options) do |sess|
+            yield sess if block_given?
+
+            print_info "Logging out ..."
+
+            sess.close
+            sess.logout
+
+            if self.port
+              print_info "Disconnecting from #{self.host}:#{self.port}"
+            else
+              print_info "Disconnecting from #{self.host}"
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,141 @@
+#
+# Copyright (c) 2006-2011 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/pop3'
+require 'ronin/ui/output/helpers'
+require 'ronin/mixin'
+
+require 'parameters'
+
+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
+
+        mixin UI::Output::Helpers, Parameters
+
+        mixin do
+          # 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'
+        end
+
+        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.
+        #
+        # @api public
+        #
+        def pop3_connect(options={},&block)
+          options[:port] ||= self.port
+          options[:user] ||= self.pop3_user
+          options[:password] ||= self.pop3_password
+
+          if self.port
+            print_info "Connecting to #{self.host}:#{self.port} ..."
+          else
+            print_info "Connecting to #{self.host} ..."
+          end
+
+          return ::Net.pop3_connect(self.host,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 pop3_connect
+        #
+        # @api public
+        #
+        def pop3_session(options={})
+          pop3_connect(options) do |sess|
+            yield sess if block_given?
+            sess.finish
+
+            if @port
+              print_info "Disconnecting to #{self.host}:#{self.port}"
+            else
+              print_info "Disconnecting to #{self.host}"
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,159 @@
+#
+# Copyright (c) 2006-2011 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/smtp'
+require 'ronin/ui/output/helpers'
+require 'ronin/mixin'
+
+require 'parameters'
+
+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
+
+        mixin UI::Output::Helpers, Parameters
+
+        mixin do
+          # 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'
+        end
+
+        protected
+
+        #
+        # @see Ronin::Network::SMTP.message
+        #
+        # @api public
+        #
+        def smtp_message(options={},&block)
+          Network::SMTP.message(options,&block)
+        end
+
+        #
+        # 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.
+        #
+        # @api public
+        #
+        def smtp_connect(options={},&block)
+          options[:port] ||= self.port
+          options[:login] ||= self.smtp_login
+          options[:user] ||= self.smtp_user
+          options[:password] ||= self.smtp_password
+
+          if self.port
+            print_info "Connecting to #{self.host}:#{self.port} ..."
+          else
+            print_info "Connecting to #{self.host} ..."
+          end
+
+          return ::Net.smtp_connect(self.host,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 smtp_connect
+        #
+        # @api public
+        #
+        def smtp_session(options={},&block)
+          smtp_connect(options) do |sess|
+            yield sess if block_given?
+            sess.close
+
+            if self.port
+              print_info "Disconnecting to #{self.host}:#{self.port}"
+            else
+              print_info "Disconnecting to #{self.host}"
+            end
+          end
+        end
+      end
+    end
+  end
+end