efivalidate 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 514d5fb2a75126d7d039f6cc058a0fc19bedfbe4
-  data.tar.gz: a0164e6b1dd712b69a02b676a7d7bc4c0c232ac3
+  metadata.gz: 84d71f648e520f9603aa92358f3954f3acfd2de7
+  data.tar.gz: e52dfe120d6d0fa2eeb4c5fc07452792c7f60ff0
 SHA512:
-  metadata.gz: 1203c3812f4f9251bc4faf8103e91b8e1b5fb3f8043812c6aa4bcf3f6e3a8919ad51cf1b0dbad544e13dde405a7d39897aa5f90a49e0237e1ab542499b0ed200
-  data.tar.gz: 51db27828f8b0f91edddd7c292c5a0ebe64daca5661aa878e02f8eb836b4419c776a54ae3e66c44110b62a0ab34a0e12fcbfe9a76add6e07cf6c448306d63758
+  metadata.gz: 14b85c0913533aa3801fdb18ea96ec6d5ae1190f7f837ea69176411c87f8d0faaf1a1c040ce794f261454271765932a7952c92efa13ad4582e7a873314ac7b50
+  data.tar.gz: b286c02363bb09b91e0231f83c7087c6589a4d066d1adef8d826ed30bdde7859136f7b2cb60912196cd3a7e3ddb32c929ba8449b24ae800355edd3959b6f3ecb

data/.rubocop.yml

@@ -0,0 +1,2 @@
+Metrics/LineLength:
+  Max: 120

data/README.md

@@ -47,12 +47,21 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/efivalidate. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at [https://github.com/dropbox/efivalidate]. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
 
-## Code of Conduct
+## We need your help!
+`efivalidate` is under active development! As you can see from the API docs, we only support a small number of features today and have only scratched the surface of what's possible. We would love feedback from you, our users, to guide what to build next and how to improve the tool.
 
-Everyone interacting in the Efivalidate project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/efivalidate/blob/master/CODE_OF_CONDUCT.md).
+So please, file feature requests, report bugs or better yet, send us pull requests! More on contributing below.
+
+## Code Changes
+
+Step 1: If you're submitting a non-trivial change, please fill out the [Dropbox Contributor License Agreement](https://opensource.dropbox.com/cla/) first.
+
+Step 2: send a [pull request](https://help.github.com/articles/using-pull-requests/)
+
+Step 3: Profit!

data/exe/efivalidate

@@ -1,29 +1,29 @@
 #!/usr/bin/env ruby
 require 'bundler/setup'
 
-require "efivalidate"
+require 'efivalidate'
 require 'optionparser'
 
 if ARGV.count != 2
   puts "efivalidate EFI_FILE EALF_FILE"
-  exit -1
+  exit(-1)
 end
 
 efi = ARGV[0]
 ealf = ARGV[1]
 
 parser = EFIValidate::EALFParser.read ealf
-validator = EFIValidate::EFIValidator.new parser, File.open(efi)
+validator = EFIValidate::EFIValidator.new parser, efi
 
 validator.validate
 
-if validator.is_valid?
+if validator.valid?
   puts "EFI file matches EALF baseline. (#{parser.rows.count} hashes match)"
 else
   puts "EFI file matched #{parser.rows.count - validator.errors.count} hashes from EALF.\n"
   puts "EFI file has #{validator.errors.count} hash errors:\n\n"
   validator.errors.each do |error|
     puts "Actual Hash: #{error.hash}"
-    puts "Expected Hash from EALF:\n#{error.row.to_s}\n\n"
+    puts "Expected Hash from EALF:\n#{error.row}\n\n"
   end
 end

data/lib/efivalidate/ealf_row.rb

@@ -16,46 +16,47 @@ module EFIValidate
     attr_accessor :header
 
     def hash
-      self.ealf_hash.each_byte.map { |b| '%02x' % b }.join
+      ealf_hash.each_byte.map { |b| '%02x' % b }.join
     end
 
     def uuid
-      UUIDTools::UUID.parse_raw(self.ealf_uuid)
+      UUIDTools::UUID.parse_raw(ealf_uuid)
     end
 
-    def is_privacy_row?
-      self.ealf_hash.each_byte.all? { |b| b == 0 }
+    def privacy_row?
+      ealf_hash.each_byte.all?(&:zero?)
+    end
+
+    def core_sec?
+      uuid == SEC_CORE
     end
 
     def to_s
-      "<#{'%02x' % ealf_component}:#{ '%02x' % self.ealf_region }:#{ "%04x" % self.ealf_master }:#{ "%08x" % self.ealf_offset }:#{ "%08x" % self.ealf_length}:#{self.format_uuid}:#{self.hash}>"
+      format '<%02x:%02x:%04x:%08x:%08x:%s:%s>', ealf_component, ealf_region, ealf_master, ealf_offset, ealf_length, format_uuid, hash
     end
 
     def format_uuid
-
-      value = EFIValidate::ROW_GUIDS[self.uuid.to_s]
-
-      if value
-        sprintf "%36.36s", value
-      else
-        self.uuid
-      end
+      format '%36.36s', (EFIValidate::ROW_GUIDS[uuid.to_s] || uuid)
     end
   end
 
-  ROW_GUIDS = { 'ef7f23e1-7ba0-a64a-baea-33edff15ba3f' => 'BIOS_EMPTY_SPACE',
-                'd954937a-6804-4a44-81ce-0bf617d890df' => 'EFI_FLASH_FILE_SYSTEM_VOLUME',
-                '8c1b00bd-716a-7b48-a14f-0c2a2dcf7a5d' => 'APPLE_IMMUTABLE_FIRMWARE_VOLUME',
-                '78e58c8c-3d8a-1c4f-9935-896185c32dd3' => 'EFI_FIRMWARE_FILE_SYSTEM_2_VOLUME',
-                'a980b9e3-e35f-e548-9b92-2798385a9027' => 'EMPTY_SHMOO_FIRMWARE_VOLUME',
-                '484c38ef-0cab-544b-8ed9-0710ad500c0f' => 'FIELD_SHMOO_FIRMWARE_VOLUME',
-                '0a369089-370e-2245-a8a7-a55041013deb' => 'DALE_SHMOO_FIRMWARE_VOLUME',
-                '97213d15-bd29-dc44-ac59-887f70e41a6b' => 'MICROCODE_FIRMWARE_VOLUME',
-                '8d2bf1ff-9676-8b4c-a985-2747075b4f50' => 'EFI_SYSTEM_NNRAM_FIRMWARE_VOLUME',
-                '096de3c3-9482-974b-a857-d5288fe33e28' => 'BIOS_IDENTIFIER',
-                'b57d69bb-60ed-ac46-8754-7580b8b27ed0' => 'APPLE_SEC_VOLUMES_FILE',
-                '2e06a01b-79c7-8245-8566-336ae8f78f09' => 'SEC_CORE',
-                '17706906-2e5f-225e-ad94-5816399c720a' => 'APPLE_ROM_MANIFEST',
-                'a3b9f5ce-6d47-7f49-9fdc-e98143e0422c' => 'AMI_NVRAM_FILE',
-                '24465000-598a-eb4e-bd0f-6b36e96128e0' => 'PHOENIX_NVRAM_FIRMWARE_VOLUME' }
+  ROW_GUIDS = { "ef7f23e1-7ba0-a64a-baea-33edff15ba3f" => 'BIOS_EMPTY_SPACE',
+                "d954937a-6804-4a44-81ce-0bf617d890df" => 'EFI_FLASH_FILE_SYSTEM_VOLUME',
+                "8c1b00bd-716a-7b48-a14f-0c2a2dcf7a5d" => 'APPLE_IMMUTABLE_FIRMWARE_VOLUME',
+                "78e58c8c-3d8a-1c4f-9935-896185c32dd3" => 'EFI_FIRMWARE_FILE_SYSTEM_2_VOLUME',
+                "a980b9e3-e35f-e548-9b92-2798385a9027" => 'EMPTY_SHMOO_FIRMWARE_VOLUME',
+                "484c38ef-0cab-544b-8ed9-0710ad500c0f" => 'FIELD_SHMOO_FIRMWARE_VOLUME',
+                "0a369089-370e-2245-a8a7-a55041013deb" => 'DALE_SHMOO_FIRMWARE_VOLUME',
+                "97213d15-bd29-dc44-ac59-887f70e41a6b" => 'MICROCODE_FIRMWARE_VOLUME',
+                "8d2bf1ff-9676-8b4c-a985-2747075b4f50" => 'EFI_SYSTEM_NNRAM_FIRMWARE_VOLUME',
+                "096de3c3-9482-974b-a857-d5288fe33e28" => 'BIOS_IDENTIFIER',
+                "b57d69bb-60ed-ac46-8754-7580b8b27ed0" => 'APPLE_SEC_VOLUMES_FILE',
+                "2e06a01b-79c7-8245-8566-336ae8f78f09" => 'SEC_CORE',
+                "17706906-2e5f-225e-ad94-5816399c720a" => 'APPLE_ROM_MANIFEST',
+                "a3b9f5ce-6d47-7f49-9fdc-e98143e0422c" => 'AMI_NVRAM_FILE',
+                "24465000-598a-eb4e-bd0f-6b36e96128e0" => 'PHOENIX_NVRAM_FIRMWARE_VOLUME' }
+
+  ROW_GUIDS.each do |key, value|
+    const_set(value, UUIDTools::UUID.parse(key))
+  end
 end

data/lib/efivalidate/ealf_updater.rb

@@ -0,0 +1,7 @@
+module EFIValidate
+   class EALFUpdater
+     UPDATE_INDEX = 'https://swscan.apple.com/content/catalogs/others/index-10.13-10.12-10.11-10.10-10.9-mountainlion-lion-snowleopard-leopard.merged-1.sucatalog.gz'
+
+     
+   end
+end

data/lib/efivalidate/efi_validation_error.rb

@@ -9,7 +9,7 @@ module EFIValidate
     end
 
     def to_s
-      @row.to_s
+      "Expected #{row} to be #{@hash}"
     end
   end
 end

data/lib/efivalidate/efi_validator.rb

@@ -1,37 +1,49 @@
 module EFIValidate
+  # Class that represents a single run of a validator against a firmware
   class EFIValidator
     attr_reader :parser, :data, :errors
 
-    def initialize(parser, data)
+    def initialize(parser, file)
       @parser = parser
-      @data = data
-    end
 
+      reader = File.open(file, mode: 'rb')
+      @data = reader.read
+      reader.close
+
+      perform_core_sec_fixup if @parser.rows.any?(&:core_sec?)
+    end
 
     def validate!
       @errors = []
 
-      @parser.rows.each do |row|
-        next if row.is_privacy_row?
-
-        @data.seek row.ealf_offset
-
-        section_data = @data.read row.ealf_length
+      @parser.rows.reject(&:privacy_row?).each do |row|
+        section_data = get_region(row.ealf_offset, row.ealf_length)
 
-        calculated_hash = @parser.header.create_hash.hexdigest (section_data || '')
+        calculated_hash = @parser.header.create_hash.hexdigest section_data
 
         @errors << EFIValidationError.new(row, section_data, calculated_hash) unless calculated_hash == row.hash
       end
     end
 
+    def get_region(offset, length)
+      @data[offset, length] || ''
+    end
+
+    def perform_core_sec_fixup
+      # Apple zeros out what appears to be a hash and checksum before validating the SEC_CORE region
+
+      @data[-0x100, 0x80] = "\0" * 0x80
+      @data[-0x04, 0x04] = "\0" * 0x04
+    end
+
     def validate
-      self.validate! unless @errors
+      validate! unless @errors
     end
 
-    def is_valid?
-      self.validate
+    def valid?
+      validate
 
-      self.errors.count == 0
+      errors.count.zero?
     end
   end
 end

data/lib/efivalidate/version.rb

@@ -1,3 +1,3 @@
 module EFIValidate
-  VERSION = "1.1.0"
+  VERSION = '1.2.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: efivalidate
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Rick Mark
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-03 00:00:00.000000000 Z
+date: 2018-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: iostruct
@@ -91,6 +91,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .rubocop.yml
 - .travis.yml
 - CODE_OF_CONDUCT.md
 - FORMAT.md
@@ -106,6 +107,7 @@ files:
 - lib/efivalidate/ealf_header.rb
 - lib/efivalidate/ealf_parser.rb
 - lib/efivalidate/ealf_row.rb
+- lib/efivalidate/ealf_updater.rb
 - lib/efivalidate/efi_validation_error.rb
 - lib/efivalidate/efi_validator.rb
 - lib/efivalidate/intel_firmware_descriptor.rb