kindle_hacks 0.1

data/CHANGELOG

@@ -0,0 +1 @@
+v0.1. Initial release.

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+ 
+Copyright (c) 2009 Zergling.Net
+ 
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+ 
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+ 
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/Manifest

@@ -0,0 +1,17 @@
+CHANGELOG
+LICENSE
+Manifest
+README.textile
+Rakefile
+bin/kindle_update
+lib/kindle_hacks.rb
+lib/kindle_hacks/update.rb
+lib/kindle_hacks/update_hl.rb
+test/fixtures/update.dat
+test/fixtures/update/001-savory.sh
+test/fixtures/update/999-reboot.sh
+test/fixtures/update/savoryctl
+test/fixtures/update/update.yml
+test/fixtures/update_dx_web.bin
+test/fixtures/update_k2_pdf.bin
+test/update_test.rb

data/README.textile

@@ -0,0 +1,18 @@
+h1. KindleHacks
+
+This gem contains code that's useful for hacking on the kindle.
+
+h2. Features
+
+Currently, the gem installs the command-line tool kindle_update that can be used
+to build and unpack Kindle updates. KindleHacks::Update implements the API used
+by the command-line tool.
+
+h2. Acknowledgments
+
+The update packing and unpacking is based on igorsk's article available at
+http://igorsk.blogspot.com/2007/12/hacking-kindle-part-2-bootloader-and.html
+
+h2. Contributions
+
+Please don't hesitate to fork the project and send pull requests.

data/Rakefile

@@ -0,0 +1,31 @@
+# Rakefile that uses echoe to manage kindle_hacks' gemspec.
+#
+# Author:: Victor Costan
+# Copyright:: Copyright (C) 2009 Zergling.Net
+# License:: MIT
+ 
+require 'rubygems'
+require 'echoe'
+ 
+Echoe.new('kindle_hacks') do |p|
+  p.project = 'zerglings' # rubyforge project
+  
+  p.author = 'Victor Costan'
+  p.email = 'victor@zergling.net'
+  p.summary = "Assorted toolbox for hacking into Kindles."
+  p.url = 'http://github.com/costan/kindle_hacks'
+  p.dependencies = ['archive-tar-minitar >=0.5.2']
+  p.development_dependencies = ["echoe >=3.1.1", "flexmock >=0.8.6"]
+  p.eval = proc do |p|
+    p.default_executable = 'bin/kindle_update'
+  end
+  
+  p.need_tar_gz = true
+  p.need_zip = true
+  p.rdoc_pattern = /^(lib|bin|tasks|ext)|^BUILD|^README|^CHANGELOG|^TODO|^LICENSE|^COPYING$/
+end
+ 
+if $0 == __FILE__
+  Rake.application = Rake::Application.new
+  Rake.application.run
+end

data/bin/kindle_update

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+#
+# Command-line tool for packing and unpacking updates.
+#
+# Author:: Victor Costan
+# Copyright:: Copyright (C) 2009 Zergling.Net
+# License:: MIT
+
+require 'fileutils'
+require 'open-uri'
+
+require 'rubygems'
+require 'kindle_hacks'
+
+case ARGV[0]
+when 'pack'
+  update = KindleHacks::Update.read_dir ARGV[1] || '.'
+  File.open(File.join(ARGV[2] || '.', update.binary_file_name), 'w') do |f|
+    f.write update.to_binary
+  end
+when 'unpack'
+  update = KindleHacks::Update.read File.read(ARGV[1])
+  FileUtils.mkdir_p ARGV[2] if ARGV[2]
+  update.to_dir ARGV[2] || '.'
+else
+  print <<END_USAGE
+Pack an update: #{$0} unpack [update_directory] [target_directory]
+Unpack an update: #{$0} pack update_file [target_directory]
+END_USAGE
+end

data/kindle_hacks.gemspec

@@ -0,0 +1,42 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{kindle_hacks}
+  s.version = "0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Victor Costan"]
+  s.date = %q{2009-10-09}
+  s.default_executable = %q{bin/kindle_update}
+  s.description = %q{Assorted toolbox for hacking into Kindles.}
+  s.email = %q{victor@zergling.net}
+  s.executables = ["kindle_update"]
+  s.extra_rdoc_files = ["CHANGELOG", "LICENSE", "README.textile", "bin/kindle_update", "lib/kindle_hacks.rb", "lib/kindle_hacks/update.rb", "lib/kindle_hacks/update_hl.rb"]
+  s.files = ["CHANGELOG", "LICENSE", "Manifest", "README.textile", "Rakefile", "bin/kindle_update", "lib/kindle_hacks.rb", "lib/kindle_hacks/update.rb", "lib/kindle_hacks/update_hl.rb", "test/fixtures/update.dat", "test/fixtures/update/001-savory.sh", "test/fixtures/update/999-reboot.sh", "test/fixtures/update/savoryctl", "test/fixtures/update/update.yml", "test/fixtures/update_dx_web.bin", "test/fixtures/update_k2_pdf.bin", "test/update_test.rb", "kindle_hacks.gemspec"]
+  s.homepage = %q{http://github.com/costan/kindle_hacks}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Kindle_hacks", "--main", "README.textile"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{zerglings}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Assorted toolbox for hacking into Kindles.}
+  s.test_files = ["test/update_test.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<archive-tar-minitar>, [">= 0.5.2"])
+      s.add_development_dependency(%q<echoe>, [">= 3.1.1"])
+      s.add_development_dependency(%q<flexmock>, [">= 0.8.6"])
+    else
+      s.add_dependency(%q<archive-tar-minitar>, [">= 0.5.2"])
+      s.add_dependency(%q<echoe>, [">= 3.1.1"])
+      s.add_dependency(%q<flexmock>, [">= 0.8.6"])
+    end
+  else
+    s.add_dependency(%q<archive-tar-minitar>, [">= 0.5.2"])
+    s.add_dependency(%q<echoe>, [">= 3.1.1"])
+    s.add_dependency(%q<flexmock>, [">= 0.8.6"])
+  end
+end

data/lib/kindle_hacks.rb

@@ -0,0 +1,8 @@
+# Top-level include file for KindleHacks.
+#
+# Author:: Victor Costan
+# Copyright:: Copyright (C) 2009 Zergling.Net
+# License:: MIT
+
+require 'kindle_hacks/update.rb'
+require 'kindle_hacks/update_hl.rb'

data/lib/kindle_hacks/update.rb

@@ -0,0 +1,248 @@
+# Code for dealing with the binary update file format.
+#
+# Author:: Victor Costan
+# Copyright:: Copyright (C) 2009 Zergling.Net
+# License:: MIT
+
+require 'digest/md5'
+require 'zlib'
+
+require 'rubygems'
+require 'archive/tar/minitar'
+
+# :nodoc: namespace
+module KindleHacks
+
+
+# :nodoc: documented in update_hl.rb
+class Update
+  # The device that the update targets, e.g. :kindle_dx.
+  attr_reader :device
+  
+  # The files that constitute the update.
+  attr_reader :files
+  
+  # The minimum firmware version that this update applies to.
+  #
+  # The recommended value is DEFAULT_MIN_VERSION.
+  attr_reader :min_version
+  
+  # The maximum firmware version that this update applies to.
+  #
+  # The recommended value is DEFAULT_MAX_VERSION.
+  attr_reader :max_version
+  
+  # The update's name, appended at the end of the update image and manifest.
+  #
+  # For example, an update named _Savory-0.06 will have its update file named
+  # update_Savory-0.06.bin and the manifest will be named
+  # update-Savory-0.06.dat.
+  attr_reader :name
+  
+  # Whether this update is optional or not.
+  attr_reader :optional
+
+  # The update's type, e.g. :ota.
+  attr_reader :update
+  
+  # Initializes an update from a potentially incomplete manifest.
+  def initialize(manifest = {})    
+    @device = manifest[:device] || :kindle
+    @device = @device.to_sym
+    @files = manifest[:files] || []
+    @files.each do |file|
+      file[:display] ||= file[:name] + '_file'
+      file[:target] = file[:target].to_sym
+    end
+    @min_version = manifest[:min_version] || DEFAULT_MIN_VERSION
+    @max_version = manifest[:max_version] || DEFAULT_MAX_VERSION
+    @name = manifest[:name] || ''
+    @optional = manifest[:optional] || 0
+    @unknown = manifest[:unknown] || DEFAULT_UNKNOWN
+    @update = manifest[:signature] || :ota
+    @update = @update.to_sym
+  end
+    
+  # Creates an Update from raw update bytes.
+  #
+  # Returns an Update object.
+  def self.read(raw_update)
+    header = decode_header raw_update
+    
+    header_size = HEADER_SIZES[header[:update]]
+    descramble_key = (SCRAMBLE_KEY >> 4 | SCRAMBLE_KEY << 4) & 0xff
+    md5 = scramble! raw_update[16, 32], descramble_key
+    tgz = scramble! raw_update[header_size..-1], descramble_key    
+    raise 'Update signature is invalid' unless Digest::MD5.hexdigest(tgz) == md5
+    
+    Update.new header.merge(decode_files(tgz))
+  end
+  
+  # Raw update bytes corresponding to an update.
+  #
+  # Returns a string that can be written to a .bin file for updating a device.
+  def to_binary
+    header = encoded_header
+    tgz = encoded_files
+    md5 = Digest::MD5.hexdigest tgz
+    scrambled_md5 = Update.scramble! md5, SCRAMBLE_KEY
+    scrambled_tgz = Update.scramble! tgz, SCRAMBLE_KEY
+    
+    [header, scrambled_md5,
+     "\0" * (HEADER_SIZES[@update] - header.length - md5.length),
+     scrambled_tgz].join
+  end
+  
+  # The update's binary file name.
+  def binary_file_name
+    "update#{@name}.bin"
+  end
+  
+  # Decodes an update's header.
+  #
+  # Args:
+  #   raw_header:: a string containing the raw update header
+  #
+  # Returns a hash that can be used as an argument to Update's constructor.
+  def self.decode_header(raw_header)
+    update_id, min_version, max_version, device_id, optional, unknown =
+        *raw_header[0, 16].unpack('a4VVvCC')
+    
+    update = UPDATE_IDS.keys.find { |k| UPDATE_IDS[k] == update_id }
+    device = DEVICE_IDS.keys.find { |k| DEVICE_IDS[k] == device_id }
+    
+    { :update => update, :min_version => min_version,
+      :max_version => max_version, :device => device, :optional => optional,
+      :unknown => unknown }
+  end
+  
+  # The encoded header for this update.
+  def encoded_header
+    [UPDATE_IDS[@update], @min_version, @max_version, DEVICE_IDS[@device],
+     @optional, @unknown].pack('a4VVvCC')
+  end
+  
+  # Decodes an update's file contents.
+  #
+  # Args:
+  #   raw_tgz:: a string containing the raw update tar.gz bytes
+  #
+  # Returns a hash that can be used as the options argument to Update's
+  # constructor.
+  def self.decode_files(raw_tgz)
+    raw_files = {}
+    
+    gz_reader = Zlib::GzipReader.new StringIO.new(raw_tgz)
+    tar_reader = Archive::Tar::Minitar::Reader.new gz_reader
+    tar_reader.each_entry do |entry|
+      raise 'Directories unsupported' if entry.directory?
+      
+      name = entry.full_name      
+      contents = entry.read
+      raw_files[name] = contents
+    end
+    tar_reader.close
+    gz_reader.close
+    
+    manifest_file = raw_files.keys.find { |name| /^update.*\.dat$/ =~ name }
+    raise 'No update*.dat manifest found' unless manifest_file
+    
+    files = decode_manifest(raw_files[manifest_file])
+    files.each { |file| file[:contents] = raw_files[file[:name]] }
+    { :name => manifest_file[6...-4], :files => files }
+  end
+  
+  # The encoded file data (tgz) for this update.
+  def encoded_files
+    raw_tgz = ""
+    gz_writer = Zlib::GzipWriter.new StringIO.new(raw_tgz)
+    tar_writer = Archive::Tar::Minitar::Writer.new gz_writer
+    
+    data = Hash[*@files.map { |file| [file[:name], file[:contents]] }.flatten]
+    data["update#{@name}.dat"] = encoded_manifest
+    mtime = Time.now.to_i
+    data.each do |name, contents|
+      tar_writer.add_file_simple(name, :mode => 0100755, :uid => 0, :gid => 0,
+          :user => 'root', :group => 'root', :mtime => mtime,
+          :size => contents.length) do |file|
+        file.write contents
+      end
+    end
+    tar_writer.close
+    gz_writer.close
+    
+    raw_tgz
+  end
+    
+  # Decodes an update file's manifest (update*.dat).
+  #
+  # Args:
+  #   raw_manifest:: a string containing the raw bytes in the manifest file
+  #
+  # Returns a hash that can be used as the :files key in the options argument to
+  # Update's constructor.
+  def self.decode_manifest(raw_manifest)
+    raw_manifest.split("\n").map do |line|
+      target_id, md5, filename, block_count, display_name = *line.split
+    
+      target = TARGET_IDS.keys.find { |k| TARGET_IDS[k].to_s == target_id }
+      { :target => target, :name => filename, :display => display_name }
+    end
+  end
+    
+  # The encoded manifest for this update.
+  def encoded_manifest
+    @files.map { |file|
+      target_id = TARGET_IDS[file[:target]]
+      md5 = Digest::MD5.hexdigest file[:contents]
+      block_count = file[:contents].length / BLOCK_SIZE[@device]
+      [target_id, md5, file[:name], block_count, file[:display]].join ' '
+    }.join("\n") + "\n"
+  end  
+
+  # Scrambles update bytes (either the MD5 or the TGZ).
+  #
+  # Args:
+  #   bytes:: the bytes to be scrambled (in-place)
+  #   key:: the scrambling key (between 0 and 255)
+  #
+  # Returns the same array passed in the bytes argument.
+  def self.scramble!(bytes, key)
+    0.upto(bytes.length - 1) do |i|
+      b = bytes[i]
+      b = (((b >> 4) | (b << 4)) & 0xFF) ^ key
+      bytes[i] = b
+    end
+    bytes
+  end
+  
+  # Default value for the unknown byte in the update header.
+  DEFAULT_UNKNOWN = 0x13
+  
+  # Default value for updates' minimum-allowed version.
+  DEFAULT_MIN_VERSION = 0
+  
+  # Default value for updates' maximum-allowed version.
+  DEFAULT_MAX_VERSION = 0x7fffffff
+  
+  # Kindle devices ID (numbers in the 3rd and 4th digits of the serial number).
+  DEVICE_IDS = {:kindle => 1, :kindle2 => 2, :kindle_dx => 4}
+  
+  # Flash partition block size.
+  BLOCK_SIZE = {:kindle => 131072, :kindle2 => 131072, :kindle_dx => 131072 }
+  
+  # Header sizes, based on update types.
+  HEADER_SIZES = {:manual => 131072, :ota => 64}
+  
+  # Target IDs in the update manifest.
+  TARGET_IDS = { :base_fs => 6, :contents_fs => 7, :temp => 128,
+                 :exec => 129 }
+  
+  # Update file signatures.
+  UPDATE_IDS = {:manual => 'FB01', :ota => 'FC02'}
+
+  # The key used to scramble update bytes.
+  SCRAMBLE_KEY = 0x7A
+end  # class
+
+end  # namespace

data/lib/kindle_hacks/update_hl.rb

@@ -0,0 +1,82 @@
+# Code for dealing with the high-level update file format.
+#
+# Author:: Victor Costan
+# Copyright:: Copyright (C) 2009 Zergling.Net
+# License:: MIT
+
+require 'yaml'
+
+# :nodoc: namespace
+module KindleHacks
+
+
+class Update
+  def self.read_dir(path)
+    manifest = YAML.load File.read(File.join(path, 'update.yml'))
+    symbolize_keys! manifest
+    
+    manifest[:files].each do |file|
+      file[:contents] = File.read File.join(path, file[:name])
+    end
+
+    Update.new manifest
+  end
+
+  def to_dir(path)
+    m = Update.stringify_keys! manifest    
+    File.open(File.join(path, 'update.yml'), 'w') { |f| YAML.dump m, f }
+    @files.each do |file|
+      File.open File.join(path, file[:name]), 'w' do |f|
+        f.write file[:contents]
+      end
+    end
+  end
+  
+  # The update's manifest.
+  def manifest
+    m = { :device => @device, :files => @files.map { |f| f.clone },
+          :min_version => @min_version, :max_version => @max_version,
+          :name => @name, :optional => @optional, :update => @update } 
+
+    m[:files].each do |file|
+      file.delete :contents
+      file.delete :display if file[:display] == file[:name] + '_file'
+    end
+    m.delete :min_version if m[:min_version] == DEFAULT_MIN_VERSION
+    m.delete :max_version if m[:max_version] == DEFAULT_MAX_VERSION
+    m
+  end
+
+  # Recursively converts a hash's keys to symbols.
+  #
+  # Returns the same hash given as an argument.
+  def self.symbolize_keys!(obj)
+    if obj.kind_of? Hash
+      obj.keys.each do |key|
+        value = obj.delete key
+        symbolize_keys! value
+        obj[key.to_sym] = value
+      end
+    elsif obj.kind_of? Array
+      obj.each { |value| symbolize_keys! value }
+    end
+    obj
+  end
+  
+  # Recursively converts a hash's keys and symbol values to strings.
+  def self.stringify_keys!(obj)
+    if obj.kind_of? Hash
+      obj.keys.each do |key|
+        value = obj.delete key
+        value = value.to_s if value.kind_of? Symbol
+        stringify_keys! value
+        obj[key.to_s] = value
+      end
+    elsif obj.kind_of? Array
+      obj.each { |value| stringify_keys! value }
+    end
+    obj
+  end
+end  # class
+
+end  # namespace

data/test/fixtures/update.dat

@@ -0,0 +1,3 @@
+128 de22e1808bd84edc219c91cff1ca89fc savoryctl 0 savoryctl_file
+129 90c7f4645f661c95f3de9893f8492506 001-savory.sh 0 001-savory.sh_file
+129 f64d5afa016a15ef6046be34067269bb 999-reboot.sh 0 999-reboot.sh_file

data/test/fixtures/update/001-savory.sh

@@ -0,0 +1,52 @@
+#!/bin/sh
+
+_FUNCTIONS=/etc/rc.d/functions
+[ -f ${_FUNCTIONS} ] && . ${_FUNCTIONS}
+
+. /etc/sysconfig/mntus
+
+VERSION_FILE=/etc/prettyversion.txt
+SAVE_PRETTY=${VERSION_FILE}-beforesavory
+NF_INI=/opt/amazon/ebook/config/netfront.ini
+SAVE_NF_INI=${NF_INI}-beforesavory
+SAVORYCTL=/etc/init.d/savoryctl
+
+# If savory is already there, bail out
+if [ -f $SAVORYCTL ]; then
+    update_progressbar 90
+    return 0
+fi
+
+
+update_progressbar 20 
+
+cp savoryctl $SAVORYCTL
+chown root.root $SAVORYCTL
+chmod 755 $SAVORYCTL
+ln -s $SAVORYCTL /etc/rc5.d/S99savoryctl
+
+update_progressbar 50
+
+
+if [ -f $NF_INI ]; then
+    cp $NF_INI $SAVE_NF_INI
+    sed 's/dlexts=prc mobi txt azw$/dlexts=prc mobi txt azw epub lrf lit pdf fb2 odt/' $SAVE_NF_INI > /tmp/netfront-temp
+    sed 's/dlmimes=application\/x-mobipocket-ebook text\/x-prc$/dlmimes=application\/x-mobipocket-ebook text\/x-prc application\/pdf/' /tmp/netfront-temp > /tmp/netfront-temp-2
+
+    if [ -s /tmp/netfront-temp-2 ]; then
+        cp /tmp/netfront-temp-2 $NF_INI
+    fi
+
+fi
+
+update_progressbar 60
+
+
+cp $VERSION_FILE $SAVE_PRETTY
+sed 's/$/ UNSUPPORTED SAVORY-0.06/' $SAVE_PRETTY > $VERSION_FILE
+
+update_progressbar 100
+
+return 0
+
+

data/test/fixtures/update/999-reboot.sh

@@ -0,0 +1,18 @@
+#!/bin/sh
+
+_FUNCTIONS=/etc/rc.d/functions
+[ -f ${_FUNCTIONS} ] && . ${_FUNCTIONS}
+
+. /etc/sysconfig/mntus
+
+rm -f ${MNTUS_MP}/update*.bin
+
+display_update_screen_success
+
+sync
+sleep 10
+
+/sbin/reboot
+
+return 0
+

data/test/fixtures/update/savoryctl

@@ -0,0 +1,35 @@
+#!/bin/sh
+PATH=/tmp/savory/bin:$PATH
+NAME="savory file conversion daemon"
+DAEMON=/tmp/savory/bin/savory_daemon
+PIDFILE=/var/run/savory-daemon.pid
+_FUNCTIONS=/etc/rc.d/functions
+[ -f ${_FUNCTIONS} ] && . ${_FUNCTIONS}
+
+case "$1" in
+
+   start)
+		mkdir /tmp/savory
+		mount -o loop -o ro /mnt/us/system/savory-image.ext3 /tmp/savory
+		if [ -x "$DAEMON" ]; then
+			msg "starting $NAME" I
+			$DAEMON -p $PIDFILE &
+		fi
+		;;
+
+   stop)
+		if [ -r "$PIDFILE" ]; then
+			msg "stopping $NAME" I
+			kill `cat $PIDFILE`
+			rm -f $PIDFILE
+			umount /tmp/savory
+		fi
+		;;
+	*)
+		msg "Usage: /etc/init.d/$NAME {start|stop}" W >&2
+		exit 1
+		;;
+esac
+
+exit 0
+

data/test/fixtures/update/update.yml

@@ -0,0 +1,12 @@
+--- 
+name: _Savory-0.06
+device: kindle2
+optional: 0
+files: 
+- name: savoryctl
+  target: temp
+- name: 001-savory.sh
+  target: exec
+- name: 999-reboot.sh
+  target: exec
+update: ota

data/test/update_test.rb

@@ -0,0 +1,124 @@
+# Author:: Victor Costan
+# Copyright:: Copyright (C) 2009 Zergling.Net
+# License:: MIT
+
+require 'kindle_hacks'
+require 'fileutils'
+require 'test/unit'
+
+class UpdateTest < Test::Unit::TestCase
+  Update = KindleHacks::Update
+  
+  def setup
+    @fixtures_path = File.join(File.dirname(__FILE__), 'fixtures')
+    @update_path = File.join(@fixtures_path, 'update')
+    
+    @kindle2_update = File.read File.join(@fixtures_path, 'update_k2_pdf.bin')
+    @kindledx_update = File.read File.join(@fixtures_path, 'update_dx_web.bin')
+    
+    @manifest = File.read File.join(@fixtures_path, 'update.dat')
+    
+    FileUtils.mkdir_p 'test_tmp'
+  end
+  
+  def teardown
+    FileUtils.rm_r 'test_tmp'
+  end
+    
+  def test_header_encoding_decoding
+    k2_golden = { :optional => 0, :update => :ota, :device => :kindle2,
+                   :unknown => Update::DEFAULT_UNKNOWN,
+                   :min_version => Update::DEFAULT_MIN_VERSION,
+                   :max_version => Update::DEFAULT_MAX_VERSION }
+    dx_golden = { :optional => 0, :update => :ota, :device => :kindle_dx,
+                   :unknown => Update::DEFAULT_UNKNOWN,
+                   :min_version => Update::DEFAULT_MIN_VERSION,
+                   :max_version => Update::DEFAULT_MAX_VERSION }
+                   
+    assert_equal k2_golden, Update.decode_header(@kindle2_update),
+                 'decoding kindle2_pdf'
+    assert_equal dx_golden, Update.decode_header(@kindledx_update),
+                 'decoding kindle_dx_web'
+
+    assert_equal @kindle2_update[0, 16], Update.new(k2_golden).encoded_header,
+                 'encoding kindle2_pdf'
+    assert_equal @kindledx_update[0, 16], Update.new(dx_golden).encoded_header,
+                 'encoding kindle_dx_pdf'
+  end
+  
+  def test_decode_manifest
+    golden = [{ :display => "savoryctl_file", :name => "savoryctl",
+                :target => :temp },
+              { :display => "001-savory.sh_file", :name => "001-savory.sh",
+                :target => :exec },
+              { :display => "999-reboot.sh_file", :name => "999-reboot.sh",
+                :target => :exec }]    
+    assert_equal golden, Update.decode_manifest(@manifest), 'decoding manifest'
+  end
+  
+  def test_read
+    update = Update.read @kindle2_update
+    assert_equal :kindle2, update.device, 'Update device'
+    assert_equal '_Savory-0.06', update.name, 'Update name'
+    assert_equal :ota, update.update, 'Update update (type)'
+    update.files.each do |file|
+      golden = File.read File.join(@update_path, file[:name])
+      assert_equal "#{file[:name]}_file", file[:display],
+                   "File #{file[:name]} display name"
+      assert_equal golden, file[:contents], "File #{file[:name]} contents"
+    end
+  end
+  
+  def test_manifest
+    golden_file = File.read File.join(@update_path, 'update.yml')
+    
+    golden = Update.symbolize_keys! YAML.load(golden_file)    
+    golden[:device] = golden[:device].to_sym
+    golden[:update] = golden[:update].to_sym
+    golden[:files].each { |f| f[:target] = f[:target].to_sym }
+    
+    assert_equal golden, Update.read(@kindle2_update).manifest
+  end
+  
+  def test_to_dir
+    update = Update.read @kindle2_update
+    update.to_dir 'test_tmp'
+    
+    Dir.entries(@update_path).each do |entry|
+      next if File.directory?(entry)
+      
+      assert File.exist?(File.join('test_tmp', entry)),
+             "Serialized update doesn't have #{entry}"
+      assert_equal File.read(File.join(@update_path, entry)),
+                   File.read(File.join('test_tmp', entry)),
+                   "Bad contents in serialized update's #{entry}"
+    end
+  end
+  
+  def test_read_dir
+    golden_update = Update.read @kindle2_update
+    update = Update.read_dir @update_path
+    
+    assert_equal golden_update.manifest, update.manifest
+    assert_equal golden_update.files, update.files
+  end
+  
+  def test_encoded_manifest
+    update = Update.read @kindle2_update
+    assert_equal @manifest, update.encoded_manifest
+  end
+  
+  def test_to_binary
+    golden_update = Update.read @kindle2_update
+    binary = golden_update.to_binary
+    update = Update.read binary
+    
+    assert_equal golden_update.manifest, update.manifest
+    assert_equal golden_update.files, update.files
+  end
+  
+  def test_binary_file_name
+    update = Update.read @kindle2_update
+    assert_equal "update_Savory-0.06.bin", update.binary_file_name
+  end
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification 
+name: kindle_hacks
+version: !ruby/object:Gem::Version 
+  version: "0.1"
+platform: ruby
+authors: 
+- Victor Costan
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-09 00:00:00 -04:00
+default_executable: bin/kindle_update
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: archive-tar-minitar
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.5.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: echoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 3.1.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: flexmock
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.8.6
+    version: 
+description: Assorted toolbox for hacking into Kindles.
+email: victor@zergling.net
+executables: 
+- kindle_update
+extensions: []
+
+extra_rdoc_files: 
+- CHANGELOG
+- LICENSE
+- README.textile
+- bin/kindle_update
+- lib/kindle_hacks.rb
+- lib/kindle_hacks/update.rb
+- lib/kindle_hacks/update_hl.rb
+files: 
+- CHANGELOG
+- LICENSE
+- Manifest
+- README.textile
+- Rakefile
+- bin/kindle_update
+- lib/kindle_hacks.rb
+- lib/kindle_hacks/update.rb
+- lib/kindle_hacks/update_hl.rb
+- test/fixtures/update.dat
+- test/fixtures/update/001-savory.sh
+- test/fixtures/update/999-reboot.sh
+- test/fixtures/update/savoryctl
+- test/fixtures/update/update.yml
+- test/fixtures/update_dx_web.bin
+- test/fixtures/update_k2_pdf.bin
+- test/update_test.rb
+- kindle_hacks.gemspec
+has_rdoc: true
+homepage: http://github.com/costan/kindle_hacks
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Kindle_hacks
+- --main
+- README.textile
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: zerglings
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Assorted toolbox for hacking into Kindles.
+test_files: 
+- test/update_test.rb