ronin-support 0.5.1 → 1.0.0.beta1

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

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+#
+# Copyright (c) 2006-2022 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/dns/idn'
+require 'ronin/support/network/ssl'
+
+begin
+  require 'net/imap'
+rescue LoadError => error
+  warn "ronin/network/imap requires the net-imap gem be listed in the Gemfile."
+  raise(error)
+end
+
+module Ronin
+  module Support
+    module Network
+      module IMAP
+        #
+        # Provides helper methods for communicating with IMAP services.
+        #
+        module Mixin
+          # Default IMAP port
+          DEFAULT_PORT = 143
+
+          # Authentication types.
+          AUTH_TYPES = {
+            login:    'LOGIN',
+            cram_md5: 'CRAM_MD5'
+          }
+
+          #
+          # Creates a connection to the IMAP server.
+          #
+          # @param [String] host
+          #   The host to connect to.
+          #
+          # @param [String, nil] user
+          #   The user to authenticate as when connecting to the server.
+          #
+          # @param [String, nil] password
+          #   The password to authenticate with when connecting to the server.
+          #
+          # @param [Integer] port
+          #   The port the IMAP server is running on.
+          #
+          # @param [Boolean, Hash, nil] ssl
+          #   Additional SSL options.
+          #
+          # @option ssl [Boolean] :verify
+          #   Specifies that the SSL certificate should be verified.
+          #
+          # @option ssl [String] :certs
+          #   The path to the file containing CA certs of the server.
+          #
+          # @param [:login, :cram_md5] auth
+          #   The type of authentication to perform when connecting to the
+          #   server. May be either `:login` or `:cram_md5`.
+          #
+          # @yield [imap]
+          #   If a block is given, it will be passed the newly created IMAP
+          #   session. Once the block returns, it will close the IMAP session.
+          #
+          # @yieldparam [Net::IMAP] imap
+          #   The newly created IMAP session object.
+          #
+          # @return [Net::IMAP, nil]
+          #   The newly created IMAP session object. If a block is given, `nil`
+          #   will be returned.
+          #
+          # @raise [ArgumentType]
+          #   The `auth:` keyword argument must be either `:login` or
+          #   `:cram_md5`.
+          #
+          # @api public
+          #
+          def imap_connect(host, user: ,
+                                 password: ,
+                                 port:  DEFAULT_PORT,
+                                 ssl:   nil,
+                                 auth: :login)
+            host = DNS::IDN.to_ascii(host)
+
+            auth_type = AUTH_TYPES.fetch(auth) do
+              raise(ArgumentError,"auth: must be either :login or :cram_md5")
+            end
+
+            case ssl
+            when Hash
+              ssl        = true
+              ssl_certs  = ssl[:certs]
+              ssl_verify = Network::SSL::VERIFY[ssl[:verify]]
+            when TrueClass
+              ssl        = true
+              ssl_certs  = nil
+              ssl_verify = nil
+            else
+              ssl        = false
+              ssl_certs  = nil
+              ssl_verify = false
+            end
+
+            imap = Net::IMAP.new(host,port,ssl,ssl_certs,ssl_verify)
+            imap.authenticate(auth_type,user,passwd)
+
+            if block_given?
+              yield imap
+              imap.logout
+              imap.close
+              imap.disconnect
+            else
+              return imap
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+#
+# Copyright (c) 2006-2022 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 <http://www.gnu.org/licenses/>.
+#
+
+require 'ronin/support/network/ip'
+
+module Ronin
+  module Support
+    module Network
+      class IP < IPAddr
+        #
+        # Provides helper methods for looking up the public and local IP
+        # address.
+        #
+        module Mixin
+          #
+          # Determines the current public IP address.
+          #
+          # @return [String, nil]
+          #   The public IP address according to {https://ipinfo.io/ip}.
+          #
+          # @see Network::IP.public_address
+          #
+          # @since 1.0.0
+          #
+          def public_address
+            Network::IP.public_address
+          end
+
+          #
+          # Determines the current public IP.
+          #
+          # @return [String, nil]
+          #   The public IP according to {https://ipinfo.io/ip}.
+          #
+          # @see Network::IP.public_ip
+          #
+          # @since 0.6.0
+          #
+          def public_ip
+            Network::IP.public_ip
+          end
+
+          #
+          # Determines the local IP addresses.
+          #
+          # @return [Array<String>]
+          #
+          # @see Network::IP.local_addresses
+          #
+          # @since 1.0.0
+          #
+          def local_addresses
+            Network::IP.local_addresses
+          end
+
+          #
+          # Determines the local IP address.
+          #
+          # @return [String]
+          #
+          # @see Network::IP.local_ip_address
+          #
+          # @since 1.0.0
+          #
+          def local_address
+            Network::IP.local_address
+          end
+
+          #
+          # Determines the local IPs.
+          #
+          # @return [Array<Network::IP>]
+          #
+          # @see Network::IP.local_ips
+          #
+          # @since 1.0.0
+          #
+          def local_ips
+            Network::IP.local_ips
+          end
+
+          #
+          # Determines the local IP.
+          #
+          # @return [Network::IP]
+          #   The private, link-local, or loopback IP.
+          #
+          # @see Network::IP.local_ip
+          #
+          # @since 0.6.0
+          #
+          def local_ip
+            Network::IP.local_ip
+          end
+        end
+      end
+    end
+  end
+end