Add #to_s

jvazquez-r7 · jvazquez-r7 · commit d1d20ee61412 · 2014-12-07T17:52:39.000-06:00
diff --git a/lib/rex/java/serialization/model/annotation.rb b/lib/rex/java/serialization/model/annotation.rb
@@ -49,6 +49,17 @@ def encode
             encoded
           end
 
+          # Creates a print-friendly string representation
+          #
+          # @return [String]
+          def to_s
+            str = '[ '
+            contents_data = contents.collect {|content| "#{print_content(content)}"}
+            str << contents_data.join(', ')
+            str << ' ]'
+            str
+          end
+
         end
       end
     end
diff --git a/lib/rex/java/serialization/model/block_data.rb b/lib/rex/java/serialization/model/block_data.rb
@@ -42,6 +42,16 @@ def decode(io)
             self
           end
 
+          # Creates a print-friendly string representation
+          #
+          # @return [String]
+          def to_s
+            contents_hex = []
+            contents.each_byte {|byte| contents_hex << "0x#{byte.to_s(16)}" }
+
+            "[ #{contents_hex.join(', ')} ]"
+          end
+
           # Serializes the Java::Serialization::Model::BlockData
           #
           # @return [String]
diff --git a/lib/rex/java/serialization/model/block_data_long.rb b/lib/rex/java/serialization/model/block_data_long.rb
@@ -53,6 +53,16 @@ def encode
 
             encoded
           end
+
+          # Creates a print-friendly string representation
+          #
+          # @return [String]
+          def to_s
+            contents_hex = []
+            contents.each_byte {|byte| contents_hex << "0x#{byte.to_s(16)}" }
+
+            "[ #{contents_hex.join(', ')} ]"
+          end
         end
       end
     end
diff --git a/lib/rex/java/serialization/model/class_desc.rb b/lib/rex/java/serialization/model/class_desc.rb
@@ -48,6 +48,13 @@ def encode
 
             encoded
           end
+
+          # Creates a print-friendly string representation
+          #
+          # @return [String]
+          def to_s
+            print_content(description)
+          end
         end
       end
     end
diff --git a/lib/rex/java/serialization/model/contents.rb b/lib/rex/java/serialization/model/contents.rb
@@ -98,6 +98,55 @@ def encode_content(content)
             encoded << content.encode
             encoded
           end
+
+          # Creates a print-friendly string representation
+          #
+          # @param content [Rex::Java::Serialization::Model::Element] the content to print
+          # @return [String]
+          def print_content(content)
+            str = ''
+
+            case content
+            when BlockData
+              str << "#{print_class(content)} { #{content.to_s} }"
+            when BlockDataLong
+              str << "#{print_class(content)} { #{content.to_s} }"
+            when EndBlockData
+              str << "#{print_class(content)}"
+            when NewObject
+              str << "#{print_class(content)} { #{content.to_s} }"
+            when ClassDesc
+              str << "#{print_class(content)} { #{content.to_s} }"
+            when NewArray
+              str << "#{print_class(content)} { #{content.to_s} }"
+            when Utf
+              str << "#{print_class(content)} { #{content.to_s} }"
+            when LongUtf
+              str << "#{print_class(content)} { #{content.to_s} } "
+            when NewEnum
+              str << "#{print_class(content)} { #{content.to_s} }"
+            when NewClassDesc
+              str << "#{print_class(content)} { #{content.to_s} }"
+            when NullReference
+              str << "#{print_class(content)}"
+            when Reset
+              str << "#{print_class(content)}"
+            when Reference
+              str << "#{print_class(content)} { #{content.to_s} }"
+            else
+              raise ::RuntimeError, 'Failed to serialize content'
+            end
+
+            str
+          end
+
+          # Creates a print-friendly string representation of the content class
+          #
+          # @param content [Rex::Java::Serialization::Model::Element] the content
+          # @return [String]
+          def print_class(content)
+            content.class.name.split('::').last
+          end
         end
       end
     end
diff --git a/lib/rex/java/serialization/model/element.rb b/lib/rex/java/serialization/model/element.rb
@@ -28,6 +28,13 @@ def decode(io)
           def encode
             ''
           end
+
+          # Creates a print-friendly string representation
+          #
+          # @return [String]
+          def to_s
+            self.class.name.split('::').last
+          end
         end
       end
     end
diff --git a/lib/rex/java/serialization/model/field.rb b/lib/rex/java/serialization/model/field.rb
@@ -105,6 +105,20 @@ def is_object?
             false
           end
 
+          # Creates a print-friendly string representation
+          #
+          # @return [String]
+          def to_s
+            str = "#{name} "
+            if is_primitive?
+              str << "(#{type})"
+            else
+              str << "(#{field_type})"
+            end
+
+            str
+          end
+
           private
 
           # Whether the type opcode is a valid one.
diff --git a/lib/rex/java/serialization/model/long_utf.rb b/lib/rex/java/serialization/model/long_utf.rb
@@ -38,6 +38,7 @@ def encode
 
             encoded
           end
+
         end
       end
     end
diff --git a/lib/rex/java/serialization/model/new_array.rb b/lib/rex/java/serialization/model/new_array.rb
@@ -8,7 +8,7 @@ class NewArray < Element
           include Rex::Java::Serialization::Model::Contents
 
           # @!attribute array_description
-          #   @return [Java::Serialization::Model::ClassDescription] The description of the array
+          #   @return [Java::Serialization::Model::ClassDesc] The description of the array
           attr_accessor :array_description
           # @!attribute type
           #   @return [String] The type of the array values
@@ -66,6 +66,15 @@ def encode
             encoded
           end
 
+          # Creates a print-friendly string representation
+          #
+          # @return [String]
+          def to_s
+            str = "#{type}, "
+            values_data = values.collect {|v| "#{v}"}
+            str << "#{values_data}"
+          end
+
           private
 
           # Deserializes the NewArray length
diff --git a/lib/rex/java/serialization/model/new_class_desc.rb b/lib/rex/java/serialization/model/new_class_desc.rb
@@ -84,6 +84,27 @@ def encode
             encoded
           end
 
+          # Creates a print-friendly string representation
+          #
+          # @return [String]
+          def to_s
+            str = "#{class_name}, [ "
+            fields_str = []
+            fields.each do |field|
+              fields_str << field.to_s
+            end
+            str << "#{fields_str.join(', ')} ]"
+
+            case super_class.description
+            when NewClassDesc
+              str << ", @super_class: #{super_class.description.class_name.to_s}"
+            when Reference
+              str << ", @super_class: #{super_class.description.to_s}"
+            end
+
+            str
+          end
+
           private
 
           # Deserializes a class serial version
diff --git a/lib/rex/java/serialization/model/new_enum.rb b/lib/rex/java/serialization/model/new_enum.rb
@@ -11,7 +11,7 @@ class NewEnum < Element
           #   @return [Java::Serialization::Model::ClassDescription] The description of the enum
           attr_accessor :enum_description
           # @!attribute constant_name
-          #   @return [Array] The constant value in the Java Enum
+          #   @return [Java::Serialization::Model::Utf] The constant value in the Java Enum
           attr_accessor :constant_name
 
           # @param stream [Rex::Java::Serialization::Model::Stream] the stream where it belongs to
@@ -50,6 +50,13 @@ def encode
             encoded
           end
 
+          # Creates a print-friendly string representation
+          #
+          # @return [String]
+          def to_s
+            constant_name.to_s
+          end
+
           private
 
           # Deserializes the NewEnum constant name
diff --git a/lib/rex/java/serialization/model/new_object.rb b/lib/rex/java/serialization/model/new_object.rb
@@ -8,7 +8,7 @@ class NewObject < Element
           include Rex::Java::Serialization::Model::Contents
 
           # @!attribute class_desc
-          #   @return [Java::Serialization::Model::ClassDescription] The description of the object
+          #   @return [Rex::Java::Serialization::Model::ClassDesc] The description of the object
           attr_accessor :class_desc
           # @!attribute class_data
           #   @return [Array] The data of the object
@@ -63,6 +63,23 @@ def encode
             encoded
           end
 
+          # Creates a print-friendly string representation
+          #
+          # @return [String]
+          def to_s
+            str  = ''
+            if class_desc.description.class == NewClassDesc
+              str << class_desc.description.class_name.to_s
+            elsif class_desc.description.class == Reference
+              str << (class_desc.description.handle - BASE_WIRE_HANDLE).to_s(16)
+            end
+
+            str << ' => { '
+            data = class_data.collect { |data| data.to_s }
+            str << data.join(', ')
+            str << ' }'
+          end
+
           private
 
           # Deserializes the class_data for a class_desc and its super classes
diff --git a/lib/rex/java/serialization/model/reference.rb b/lib/rex/java/serialization/model/reference.rb
@@ -45,6 +45,13 @@ def encode
 
             encoded
           end
+
+          # Creates a print-friendly string representation
+          #
+          # @return [String]
+          def to_s
+            "0x#{handle.to_s(16)}"
+          end
         end
       end
     end
diff --git a/lib/rex/java/serialization/model/stream.rb b/lib/rex/java/serialization/model/stream.rb
@@ -66,6 +66,24 @@ def add_reference(ref)
             self.references.push(ref)
           end
 
+          # Creates a print-friendly string representation
+          #
+          # @return [String]
+          def to_s
+            str = "@magic: 0x#{magic.to_s(16)}\n"
+            str << "@version: #{version}\n"
+            str << "@contents: [\n"
+            contents.each do |content|
+              str << "  #{print_content(content)}\n"
+            end
+            str << "]\n"
+            str << "@references: [\n"
+            references.each do |ref|
+                str << "  [#{(references.index(ref) + BASE_WIRE_HANDLE).to_s(16)}] #{print_content(ref)}\n"
+            end
+            str << "]\n"
+          end
+
           private
 
           # Deserializes the magic stream value
diff --git a/lib/rex/java/serialization/model/utf.rb b/lib/rex/java/serialization/model/utf.rb
@@ -53,6 +53,13 @@ def encode
 
             encoded
           end
+
+          # Creates a print-friendly string representation
+          #
+          # @return [String]
+          def to_s
+            contents
+          end
         end
       end
     end
diff --git a/spec/lib/rex/java/serialization/model/annotation_spec.rb b/spec/lib/rex/java/serialization/model/annotation_spec.rb
@@ -86,4 +86,17 @@
     end
 
   end
+
+  describe "#to_s" do
+    it "prints an empty annotation" do
+      annotation.decode(empty_contents_io)
+      expect(annotation.to_s).to eq('[ EndBlockData ]')
+    end
+
+    it "prints an annotation with contents" do
+      annotation.decode(contents_io)
+      expect(annotation.to_s).to eq('[ BlockData { [ 0x1, 0x2, 0x3, 0x4, 0x5 ] }, BlockDataLong { [ 0x1, 0x2, 0x3, 0x4, 0x5 ] }, EndBlockData ]')
+    end
+  end
+
 end
diff --git a/spec/lib/rex/java/serialization/model/block_data_long_spec.rb b/spec/lib/rex/java/serialization/model/block_data_long_spec.rb
@@ -87,5 +87,18 @@
         expect(block.contents).to eq("\x01\x02\x03\x04\x05\x06\x07\x08\x09\x0a\x0b\x0c\x0d\x0e\x0f\x10")
       end
     end
+
+    describe "#to_s" do
+      it "prints a block with contents" do
+        block.decode(sample_block_io)
+        expect(block.to_s).to eq('[ 0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8, 0x9, 0xa, 0xb, 0xc, 0xd, 0xe, 0xf, 0x10 ]')
+      end
+
+      it "prints an empty string for an empty block" do
+        block.decode(empty_block_io)
+        expect(block.to_s).to eq('[  ]')
+      end
+    end
+
   end
 end
diff --git a/spec/lib/rex/java/serialization/model/block_data_spec.rb b/spec/lib/rex/java/serialization/model/block_data_spec.rb
@@ -88,4 +88,16 @@
       end
     end
   end
+
+  describe "#to_s" do
+    it "prints a block with contents" do
+      block.decode(sample_block_io)
+      expect(block.to_s).to eq('[ 0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8, 0x9, 0xa, 0xb, 0xc, 0xd, 0xe, 0xf, 0x10 ]')
+    end
+
+    it "prints an empty string for an empty block" do
+      block.decode(empty_block_io)
+      expect(block.to_s).to eq('[  ]')
+    end
+  end
 end
diff --git a/spec/lib/rex/java/serialization/model/class_desc_spec.rb b/spec/lib/rex/java/serialization/model/class_desc_spec.rb
@@ -68,4 +68,11 @@
       expect(class_desc.encode.unpack("C*")).to eq(sample.unpack("C*"))
     end
   end
+
+  describe "#to_s" do
+    it "prints a sample ClassDesc" do
+      class_desc.decode(sample_io)
+      expect(class_desc.to_s).to be_a(String)
+    end
+  end
 end
diff --git a/spec/lib/rex/java/serialization/model/field_spec.rb b/spec/lib/rex/java/serialization/model/field_spec.rb
diff --git a/spec/lib/rex/java/serialization/model/long_utf_spec.rb b/spec/lib/rex/java/serialization/model/long_utf_spec.rb
diff --git a/spec/lib/rex/java/serialization/model/new_array_spec.rb b/spec/lib/rex/java/serialization/model/new_array_spec.rb
diff --git a/spec/lib/rex/java/serialization/model/new_class_desc_spec.rb b/spec/lib/rex/java/serialization/model/new_class_desc_spec.rb
diff --git a/spec/lib/rex/java/serialization/model/new_enum_spec.rb b/spec/lib/rex/java/serialization/model/new_enum_spec.rb
diff --git a/spec/lib/rex/java/serialization/model/new_object_spec.rb b/spec/lib/rex/java/serialization/model/new_object_spec.rb
diff --git a/spec/lib/rex/java/serialization/model/stream_spec.rb b/spec/lib/rex/java/serialization/model/stream_spec.rb
diff --git a/spec/lib/rex/java/serialization/model/utf_spec.rb b/spec/lib/rex/java/serialization/model/utf_spec.rb
diff --git a/tools/java_deserializer.rb b/tools/java_deserializer.rb

-Original file line number
+Diff line change
             encoded
           end
++
         end
       end
     end