Added Network::Defang.defang (closes #547).

Author: postmodern

lib/ronin/support/network/defang.rb

@@ -16,6 +16,9 @@
 # along with ronin-support.  If not, see <https://www.gnu.org/licenses/>.
 #
 
+require_relative 'url'
+require_relative 'ip'
+
 module Ronin
   module Support
     module Network
@@ -159,6 +162,31 @@ def self.refang_url(url)
           end
         end
 
+        #
+        # Defangs a URL, IP address, or host name.
+        #
+        # @param [String] string
+        #   The URL, IP address, or host name.
+        #
+        # @return [String]
+        #   The defanged URL, IP address, or host name.
+        #
+        # @example
+        #   Defang.defang("https://www.example.com:8080/foo?q=1")
+        #   # => "hxxps[://]www[.]example[.]com[:]8080/foo?q=1"
+        #   Defang.defang("192.168.1.1")
+        #   # => "192[.]168[.]1[.]1"
+        #   Defang.defang("www.example.com")
+        #   # => "www[.]example[.]com"
+        #
+        def self.defang(string)
+          case string
+          when IP::REGEX  then defang_ip(string)
+          when URL::REGEX then defang_url(string)
+          else                 defang_host(string)
+          end
+        end
+
         #
         # Refangs a defanged URL, IP address, or host name.
         #

spec/network/defang_spec.rb

@@ -190,6 +190,44 @@
     end
   end
 
+  describe ".defang" do
+    context "when given a defanged URL" do
+      let(:url)      { 'http://www.example.com/foo?q=1' }
+      let(:defanged) { 'hxxp[://]www[.]example[.]com/foo?q=1' }
+
+      it "must return the defanged URL" do
+        expect(subject.defang(url)).to eq(defanged)
+      end
+    end
+
+    context "when given a defanged IPv4 address" do
+      let(:ip)       { '192.168.1.1' }
+      let(:defanged) { '192[.]168[.]1[.]1' }
+
+      it "must return the defanged IPv4 address" do
+        expect(subject.defang(ip)).to eq(defanged)
+      end
+    end
+
+    context "when given a defanged IPv6 address" do
+      let(:ip)       { '2606:2800:21f:cb07:6820:80da:af6b:8b2c' }
+      let(:defanged) { '2606[:]2800[:]21f[:]cb07[:]6820[:]80da[:]af6b[:]8b2c' }
+
+      it "must return the defanged IPv6 address" do
+        expect(subject.defang(ip)).to eq(defanged)
+      end
+    end
+
+    context "when given a defanged host name" do
+      let(:host)     { 'www.example.com' }
+      let(:defanged) { 'www[.]example[.]com' }
+
+      it "must return the defanged host name" do
+        expect(subject.defang(host)).to eq(defanged)
+      end
+    end
+  end
+
   describe ".refang" do
     context "when given a defanged URL" do
       let(:defanged) { 'hxxp[://]www[.]example[.]com/foo?q=1' }