resilience 0.0.2 → 0.1.1

data/lib/resilience/cli/bin/reach.rb

@@ -0,0 +1,34 @@
+# Resilience reach cli util
+#
+# Licensed under the MIT license
+# Copyright (C) 2015 Red Hat, Inc.
+###########################################################
+
+require 'optparse'
+
+def reach_option_parser
+  OptionParser.new do |opts|
+    default_options opts
+    image_options   opts
+  end
+end
+
+def check_sequence
+  @check_sequence  ||= 0xe010002800000038 # inverted due to endian ordering
+end
+
+def sequence_length
+  @sequence_length ||= 8
+end
+
+def run_search
+  while check = image.read(sequence_length)
+    unpacked = check.unpack('Q').first
+    write_match if unpacked == check_sequence
+  end
+end
+
+def write_match
+  puts 'File at: 0x' + image.total_pos.to_s(16)      +
+       ' cluster '   + (image.pos / 0x4000).to_s(16)
+end

data/lib/resilience/cli/bin/rex.rb

@@ -0,0 +1,33 @@
+# Resilience rex cli util
+#
+# Licensed under the MIT license
+# Copyright (C) 2015 Red Hat, Inc.
+###########################################################
+
+require 'optparse'
+
+def rex_option_parser
+  OptionParser.new do |opts|
+    default_options    opts
+    image_options      opts
+    output_fs_options  opts
+    stdout_options     opts
+  end
+end
+
+def write_results(image)
+  create_output_dir!
+
+  dirs  = image.root_dir.dirs
+  dirs.each do |dir|
+    puts "Dir: #{dir.fullname} at #{dir.total_offset}" if conf.dirs?
+  end
+
+  files = image.root_dir.files
+  files.each do |file|
+    puts "File: #{file.fullname} at #{file.total_offset}" if conf.files?
+
+    path = "#{output_dir}/#{file.fullname}".delete("\0")
+    File.write(path, file.metadata) if write_to_output_dir?
+  end
+end

data/lib/resilience/cli/bin/rinfo.rb

@@ -0,0 +1,19 @@
+# Resilience rinfo cli util
+#
+# Licensed under the MIT license
+# Copyright (C) 2015 Red Hat, Inc.
+###########################################################
+
+require 'optparse'
+
+def rinfo_option_parser
+  OptionParser.new do |opts|
+    default_options    opts
+    image_options      opts
+    disk_options       opts
+  end
+end
+
+def dump_info
+  puts header_output
+end

data/lib/resilience/cli/conf.rb

@@ -0,0 +1,14 @@
+#!/usr/bin/ruby
+# Reslience CLI Conf
+#
+# Licensed under the MIT license
+# Copyright (C) 2015 Red Hat, Inc.
+###########################################################
+
+module Resilience
+  module CLI
+    def conf
+      Conf
+    end
+  end # mdoule CLI
+end

data/lib/resilience/cli/default.rb

@@ -0,0 +1,17 @@
+#!/usr/bin/ruby
+# Reslience CLI Default Options
+#
+# Licensed under the MIT license
+# Copyright (C) 2015 Red Hat, Inc.
+###########################################################
+
+module Resilience
+  module CLI
+    def default_options(option_parser)
+      option_parser.on('-h', '--help', 'Print help message') do
+        puts option_parser
+        exit
+      end
+    end
+  end # module CLI
+end # module Resilience

data/lib/resilience/cli/disk.rb

@@ -0,0 +1,40 @@
+#!/usr/bin/ruby
+# Resilience Disk Options
+#
+# Licensed under the MIT license
+# Copyright (C) 2015 Red Hat, Inc.
+###########################################################
+
+module Resilience
+  module CLI
+    def disk_options(option_parser)
+      option_parser.on("-m", "--mbr", "Extract FS Info From MBR") do
+        conf.mbr = true
+      end
+
+      option_parser.on("-g", "--gpt", "Extract FS Info From GUID Partition Table") do
+        conf.gpt = true
+      end
+    end
+
+    def mbr2offset
+      return unless conf.mbr
+      image.offset  = 0
+      offset        = MBR.new.refs_offset
+      conf[:offset] = offset unless offset.nil?
+    end
+
+    def gpt2offset
+      return unless conf.gpt
+      image.offset = 0
+      image.offset = MBR.new.gpt_offset
+      image.offset = conf.offset = GPT.new.refs_offset
+    end
+
+    def boot2offset
+      setup_image
+      mbr2offset if conf.mbr
+      gpt2offset if conf.gpt
+    end
+  end # module CLI
+end # module Resilience

data/lib/resilience/cli/file.rb

@@ -0,0 +1,23 @@
+#!/usr/bin/ruby
+# Reslience File Options
+#
+# Licensed under the MIT license
+# Copyright (C) 2015 Red Hat, Inc.
+###########################################################
+
+module Resilience
+  module CLI
+    def file_select_options(option_parser)
+      option_parser.on("-f", "--file [file]", "File to analyze") do |file|
+        conf.file = file
+      end
+    end
+
+    def verify_file!
+      unless conf.file
+        puts "--file param needed"
+        exit 1
+      end
+    end
+  end # module CLI
+end # module Resilience

data/lib/resilience/cli/image.rb

@@ -0,0 +1,45 @@
+#!/usr/bin/ruby
+# Reslience CLI Image Options
+#
+# Licensed under the MIT license
+# Copyright (C) 2015 Red Hat, Inc.
+###########################################################
+
+module Resilience
+  module CLI
+    def image_options(option_parser)
+      option_parser.on("-i", "--image path", "Path to the disk image to parse") do |path|
+        conf.image_file = path
+      end
+
+      option_parser.on("-o", "--offset bytes", "Start of volume with ReFS filesystem") do |offset|
+        conf.offset = offset.to_i
+      end
+    end
+
+    def verify_image!
+      unless conf.image && conf.offset
+        puts "--image and --offset params needed"
+        exit 1
+      end
+    end
+
+    def setup_image
+      file         = File.open(conf.image_file, 'rb')
+      image.file   = file
+      image.offset = conf.offset
+      image.opts   = conf
+      image
+    end
+
+    def parse_image
+      setup_image
+      image.parse
+      image
+    end
+
+    def image
+      Resilience::OnImage.image
+    end
+  end # module CLI
+end # module Resilience

data/lib/resilience/cli/metadata.rb

@@ -0,0 +1,24 @@
+#!/usr/bin/ruby
+# Reslience Metadata Default Options
+#
+# Licensed under the MIT license
+# Copyright (C) 2015 Red Hat, Inc.
+###########################################################
+
+module Resilience
+  module CLI
+    def metadata_options(option_parser)
+      option_parser.on("-a", "--attributes", "Include attribute analysis in output") do
+        conf.attributes   = true
+      end
+
+      option_parser.on("--table", "Include object table analysis in output") do
+        conf.object_table = true
+      end
+
+      option_parser.on("--tree", "Include object tree analysis in output") do
+        conf.object_tree  = true
+      end
+    end
+  end # module CLI
+end # module Resilience

data/lib/resilience/cli/output.rb

@@ -0,0 +1,84 @@
+#!/usr/bin/ruby
+# Reslience CLI Output Options
+#
+# Licensed under the MIT license
+# Copyright (C) 2015 Red Hat, Inc.
+###########################################################
+
+require 'colored'
+
+module Resilience
+  module CLI
+    OUTPUT_LABELS = {
+      :bps    => "(bytes per sector)",
+      :spc    => "(sectors per cluster)",
+      :bpc    => "(bytes per cluster)",
+      :vbr    => "VBR",
+      :image  => "Analyzed ReFS filesystem on",
+      :offset => "starting at"
+    }
+
+    def output_fs_options(option_parser)
+      option_parser.on("--write dir", "Write output to directory") do |dir|
+        conf.dir = dir
+      end
+    end
+
+    def stdout_options(option_parser)
+      option_parser.on("-f", "--files", "List files in output") do
+        conf.files = true
+      end
+
+      option_parser.on("-d", "--dirs", "List dirs in output") do
+        conf.dirs = true
+      end
+    end
+
+    def verify_output_dir!
+      unless conf.dir
+        puts "--write param needed"
+        exit 1
+      end
+    end
+
+    def output_dir
+      conf.dir
+    end
+
+    def write_to_output_dir?
+      !!output_dir
+    end
+
+    def create_output_dir!
+      return unless write_to_output_dir?
+      Dir.mkdir(output_dir) unless File.directory?(output_dir)
+    end
+
+    def image_output
+      "#{OUTPUT_LABELS[:image]} #{conf.image_file.green.bold} "\
+      "#{OUTPUT_LABELS[:offset]} #{conf.offset.to_s.green.bold}\n"
+    end
+
+    def header_output
+      image_output + vbr_output
+    end
+
+    def bytes_per_sector_output
+      "#{image.bytes_per_sector.indented.yellow.bold} (#{OUTPUT_LABELS[:bps]})"
+    end
+
+    def sectors_per_cluster_output
+      "#{image.sectors_per_cluster.indented.yellow.bold} (#{OUTPUT_LABELS[:spc]})"
+    end
+
+    def cluster_size_output
+      "#{image.cluster_size.indented.yellow.bold} (#{OUTPUT_LABELS[:bpc]})\n"
+    end
+
+    def vbr_output
+      "#{OUTPUT_LABELS[:vbr]}: #{bytes_per_sector_output} * "    \
+                              "#{sectors_per_cluster_output} = " \
+                              "#{cluster_size_output}"
+    end
+  end # module CLI
+end # module Resilience

data/lib/resilience/collections/dirs.rb

@@ -0,0 +1,8 @@
+#!/usr/bin/ruby
+# ReFS Dirs Collection
+# Copyright (C) 2015 Red Hat Inc.
+
+module Resilience
+  class Dirs < Array
+  end
+end

data/lib/resilience/collections/files.rb

@@ -0,0 +1,41 @@
+#!/usr/bin/ruby
+# ReFS Files Collection
+# Copyright (C) 2015 Red Hat Inc.
+
+module Resilience
+  class Files < Array
+    def names
+      collect { |f| f.name }
+    end
+
+    def fullnames
+      collect { |f| f.fullname }
+    end
+
+    def at(path)
+      find { |f| f.fullname == path }
+    end
+
+    def byte_map
+      bytes = []
+      each do |file|
+        0.upto(file.metadata.size-1) do |byte_index|
+          bytes[byte_index] ||= {}
+          bytes[byte_index][file] = file.metadata[byte_index]
+        end
+      end
+      bytes
+    end
+
+    def bytes_diff
+      map = byte_map
+      different_bytes = []
+      0.upto(map.size-1).each do |byte_index|
+        bytes = map[byte_index].values
+        different = bytes.uniq.size != 1 || bytes.size != size
+        different_bytes << (different ? map[byte_index] : nil)
+      end
+      different_bytes
+    end
+  end
+end

data/lib/resilience/collections/pages.rb

@@ -0,0 +1,16 @@
+#!/usr/bin/ruby
+# ReFS Pages Collection
+# Copyright (C) 2015 Red Hat Inc.
+
+module Resilience
+  class Pages < Hash
+    def with_number(virtual_page_number)
+      select { |page_id, page| page.virtual_page_number == virtual_page_number }
+    end
+
+    def newest_for(virtual_page_number)
+      pages = with_number(virtual_page_number)
+      pages.values.sort { |p1, p2| p2.sequence <=> p1.sequence }.first
+    end
+  end
+end

data/lib/resilience/conf.rb

@@ -0,0 +1,28 @@
+#!/usr/bin/ruby
+# Reslience Conf
+#
+# Licensed under the MIT license
+# Copyright (C) 2015 Red Hat, Inc.
+###########################################################
+
+module Resilience
+  module Conf
+    def self.conf
+      @conf ||= {}
+    end
+
+    def self.method_missing(method, *args)
+      if method.to_s =~ /=$/
+        conf[method.to_s.match(/^(.*)=$/)[1].to_sym] = args.first
+      elsif method.to_s =~ /\?$/
+        !!conf[method.to_s.match(/^(.*)\?$/)[1].to_sym]
+      else
+        conf[method]
+      end
+    end
+
+    def conf
+      Conf
+    end
+  end # module Conf
+end