Constellation-crxmake 1.0.0

data/README.rdoc

@@ -0,0 +1,76 @@
+= crxmake
+
+* http://github.com/Constellation/crxmake
+
+== DESCRIPTION:
+
+make chromium extensions
+
+== SYNOPSIS:
+ruby code
+  require 'crxmake'
+  CrxMake.make(
+    :ex_dir => "./src",
+    :pkey   => "./test.pem",
+    :crx_output => "./package/test.crx",
+    :verbose => true,
+    :ignorefile => /\.swp/,
+    :ignoredir => /\.(?:svn|git|cvs)/
+  )
+
+command line
+  $ crxmake --pack-extension=<extension dir> --extension-output=<extension output path> --pack-extension-key=<pem path>
+
+  required opt
+   --pack-extension=<extension dir>
+     extension source directory
+  
+  optional opt
+   --extension-output=<extension output path>
+     crx output path (default: ./<extension dirname>.crx)
+   --pack-extension-key=<pem path>
+     pem key path
+   --key-output=<key path>
+     pem key output path if you generate key (default: ./<extension
+  dirname>.pem)
+  --ignore-file=<pattern>
+    pattern to ignore files
+    pattern is compiled by Regexp.new(<pattern>)
+  --ignore-dir=<pattern>
+    pattern to ignore directories
+    pattern is compiled by Regexp.new(<pattern>)
+
+== REQUIREMENTS:
+
+* openssl
+* zipruby
+
+== INSTALL:
+
+  gem source -a http://gems.github.com
+  sudo gem install Constellation-crxmake
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Constellation
+
+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/Rakefile

@@ -0,0 +1,95 @@
+# vim: fileencoding=utf-8
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rake/contrib/rubyforgepublisher'
+require 'rake/contrib/sshpublisher'
+require 'fileutils'
+require 'lib/crxmake'
+include FileUtils
+
+$version = CrxMake::VERSION
+$readme = 'README.rdoc'
+$rdoc_opts = %W(--main #{$readme} --charset utf-8 --line-numbers --inline-source)
+$name = 'crxmake'
+$summary = 'make chromium extension'
+$author = 'Constellation'
+$email = 'utatane.tea@gmail.com'
+$page = 'http://github.com/Constellation/crxmake/tree/master'
+$exec = %W(crxmake)
+$rubyforge_project = 'crxmake'
+
+
+task :default => [:test]
+task :package => [:clean]
+
+Rake::TestTask.new("test") do |t|
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = true
+end
+
+spec = Gem::Specification.new do |s|
+  s.name = $name
+  s.version = $version
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+  s.extra_rdoc_files = [$readme]
+  s.rdoc_options += $rdoc_opts
+  s.summary = $summary
+  s.description = $summary
+  s.author = $author
+  s.email = $email
+  s.homepage = $page
+  s.executables = $exec
+  s.rubyforge_project = $rubyforge_project
+  s.bindir = 'bin'
+  s.require_path = 'lib'
+  s.test_files = Dir["test/*_test.rb"]
+  {
+    "zipruby" => ">=0.3.2",
+#    "openssl" => ">=1.0.0"
+  }.each do |dep, ver|
+    s.add_dependency(dep, ver)
+  end
+  s.files = %w(README.rdoc Rakefile) + Dir["{bin,test,lib}/**/*"]
+end
+
+Rake::GemPackageTask.new(spec) do |p|
+  p.need_tar = true
+  p.gem_spec = spec
+end
+
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'doc'
+  rdoc.options += $rdoc_opts
+#  rdoc.template = 'resh'
+  rdoc.rdoc_files.include("README.rdoc", "lib/**/*.rb", "ext/**/*.c")
+end
+
+desc "gem spec"
+task :gemspec do
+  File.open("#{$name}.gemspec", "wb") do |f|
+    f << spec.to_ruby
+  end
+end
+
+desc "gem build"
+task :build => [:gemspec] do
+  sh "gem build #{$name}.gemspec"
+end
+
+desc "gem install"
+task :install => [:build] do
+  sh "sudo gem install #{$name}-#{$version}.gem --local"
+end
+
+desc "gem uninstall"
+task :uninstall do
+  sh "sudo gem uninstall #{$name}"
+end
+# vim: syntax=ruby

data/bin/crxmake

@@ -0,0 +1,68 @@
+#!/usr/bin/ruby
+# vim: fileencoding=utf-8
+require 'rubygems'
+require 'optparse'
+require 'crxmake'
+
+data = {}
+usage = <<-EOS
+option not valid
+
+[usage]
+  required opt
+   --pack-extension=<extension dir>
+     extension source directory
+
+  optional opt
+   --extension-output=<extension output path>
+     crx output path (default: ./<extension dirname>.crx)
+   --pack-extension-key=<pem path>
+     pem key path
+   --key-output=<key path>
+     pem key output path if you generate key (default: ./<extension
+  dirname>.pem)
+  --ignore-file=<pattern>
+    pattern to ignore files
+    pattern is compiled by Regexp.new(<pattern>)
+  --ignore-dir=<pattern>
+    pattern to ignore directories
+    pattern is compiled by Regexp.new(<pattern>)
+    EOS
+
+OptionParser.new('Packaging Chromium Extension') do |opt|
+  opt.version = '2'
+  opt.on('--pack-extension DIR') do |val|
+    data[:ex_dir] = val
+  end
+  opt.on('--pack-extension-key KEY') do |key|
+    data[:pkey] = key
+  end
+  opt.on('--key-output OKEY') do |okey|
+    data[:pkey_output] = okey
+  end
+  opt.on('--extension-output CRX') do |crx|
+    data[:crx_output] = crx
+  end
+  opt.on('--ignore-file FILE') do |file|
+    data[:ignorefile] = Regexp.new file
+  end
+  opt.on('--ignore-dir DIR') do |dir|
+    data[:ignoredir] = Regexp.new dir
+  end
+  opt.on('-v', '--verbose') do
+    data[:verbose] = true
+  end
+  begin
+    opt.parse!(ARGV)
+  rescue
+    puts usage
+   end
+end
+
+begin
+  CrxMake.make(data)
+rescue => e
+  puts e.message
+  puts usage
+end
+

data/lib/crxmake.rb

@@ -0,0 +1,190 @@
+#!/usr/bin/ruby
+# vim: fileencoding=utf-8
+require 'rubygems'
+require 'zipruby'
+require 'openssl'
+require 'digest/sha1'
+require 'fileutils'
+require 'find'
+
+class CrxMake < Object
+  VERSION = '1.0.0'
+  @@magic = [?C, ?r, ?2, ?4].pack('C*')
+  # this is chromium extension version
+  @@version = [2].pack('L')
+
+  # CERT_PUBLIC_KEY_INFO struct
+  @@key_algo = %w(30 81 9F 30 0D 06 09 2A 86 48 86 F7 0D 01 01 01 05 00 03 81 8D 00 30 81 89 02 81 81).map{|s| s.hex}.pack('C*')
+  @@key_foot = %w(02 03 01 00 01).map{|s| s.hex}.pack('C*')
+  @@key_size = 1024
+  def initialize opt
+    check_valid_option(opt)
+    if @pkey
+      read_key
+    else
+      generate_key
+    end
+    create_zip
+    sign_zip
+    write_crx
+  ensure
+    final
+  end
+
+  private
+  def check_valid_option o
+    @exdir, @pkey, @pkey_o, @crx, @verbose, @ignorefile, @ignoredir = o[:ex_dir], o[:pkey], o[:pkey_output], o[:crx_output], o[:verbose], o[:ignorefile], o[:ignoredir]
+    @exdir = File.expand_path(@exdir) if @exdir
+    raise "extension dir not exist" if !@exdir || !File.exist?(@exdir) || !File.directory?(@exdir)
+    @pkey = File.expand_path(@pkey) if @pkey
+    raise "private key not exist" if @pkey && (!File.exist?(@pkey) || !File.file?(@pkey))
+    if @pkey_o
+      @pkey_o = File.expand_path(@pkey_o)
+      raise "private key output path is directory" if File.directory?(@pkey_o)
+    else
+      count = 0
+      loop do
+        if count.zero?
+          @pkey_o = File.expand_path("./#{File.basename(@exdir)}.pem")
+        else
+          @pkey_o = File.expand_path("./#{File.basename(@exdir)}-#{count+=1}.pem")
+        end
+        break unless File.directory?(@pkey_o)
+      end
+    end
+    if @crx
+      @crx = File.expand_path(@crx)
+      raise "crx path is directory" if File.directory?(@crx)
+    else
+      count = 0
+      loop do
+        if count.zero?
+          @crx = File.expand_path("./#{File.basename(@exdir)}.crx")
+        else
+          @crx = File.expand_path("./#{File.basename(@exdir)}-#{count+=1}.crx")
+        end
+        break unless File.directory?(@crx)
+      end
+    end
+    @crx_dir = File.dirname(@crx)
+    puts <<-EOS if @verbose
+crx output dir: #{@crxdir}
+ext dir: #{@exdir}
+    EOS
+    @zip = File.join(@crx_dir, 'extension.zip')
+  end
+
+  def read_key
+    puts "read pemkey, \"#{@pkey}\"" if @verbose
+    File.open(@pkey, 'rb') do |io|
+      @key = OpenSSL::PKey::RSA.new(io)
+    end
+  end
+
+  def generate_key
+    puts "generate pemkey to  \"#{@pkey_o}\"" if @verbose
+    @key = OpenSSL::PKey::RSA.generate(@@key_size)
+    # save key
+    File.open(@pkey_o, 'wb') do |file|
+      file << @key.export()
+    end
+  end
+
+  def create_zip
+    puts "create zip" if @verbose
+    Zip::Archive.open(@zip, Zip::CREATE | Zip::TRUNC) do |zip|
+      Find.find(@exdir) do |path|
+        unless path == @exdir
+          if File.directory?(path)
+            if @ignoredir && File.basename(path) =~ @ignoredir
+              puts "ignore dir: \"#{path}\"" if @verbose
+              Find.prune
+            else
+              puts "include dir: \"#{path}\"" if @verbose
+              zip.add_dir(get_relative(@exdir, path))
+            end
+          else
+            if @ignorefile && File.basename(path) =~ @ignorefile
+              puts "ignore file: \"#{path}\"" if @verbose
+            else
+              puts "include file: \"#{path}\"" if @verbose
+              zip.add_file(get_relative(@exdir, path), path)
+            end
+          end
+        end
+      end
+    end
+    puts <<-EOS if @verbose
+create zip...done
+zip file at #{@zip}
+    EOS
+  end
+
+  def get_relative base, target
+    if base == target
+      return '.'
+    end
+    if base[base.size - 1] != ?/
+      base += '/'
+    end
+    target.sub(Regexp.escape(base), '')
+  end
+
+  def sign_zip
+    puts "sign zip" if @verbose
+    plain = nil
+    File.open(@zip, 'rb') do |file|
+      plain = file.read
+    end
+    @sig = @key.sign(OpenSSL::Digest::SHA1.new, plain)
+  end
+
+  def write_crx
+    print "write crx..." if @verbose
+    key = @@key_algo + key_data + @@key_foot
+    File.open(@crx, 'wb') do |file|
+      file << @@magic
+      file << @@version
+      file << to_sizet(key.size)
+      file << to_sizet(@sig.size)
+      file << key
+      file << @sig
+      File.open(@zip, 'rb') do |zip|
+        file << zip.read
+      end
+    end
+    puts "done" if @verbose
+  end
+
+  def key_data
+    pubkey = @key.public_key
+    memo = pubkey.to_text.split(/\r|\n|\n\r/).inject({:flag => false, :data => []}){|memo, line|
+      if memo[:flag]
+        if line =~ /^\s+/
+          memo[:data].push(*line.strip.split(':'))
+        else
+          memo[:flag] = false
+        end
+      elsif /^Modulus/ =~ line
+        memo[:flag] = true
+      end
+      memo
+    }
+    data = memo[:data].map{|s| s.hex}.pack('C*')
+    return data
+  end
+
+  def to_sizet num
+    return [num].pack('L')
+  end
+
+  def final
+    FileUtils.rm_rf(@zip) if @zip && File.exist?(@zip)
+  end
+
+  class << self
+    alias make new
+  end
+end
+
+

data/test/crxmake_test.rb

@@ -0,0 +1,35 @@
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/crxmake'
+require 'fileutils'
+require 'pp'
+require 'open-uri'
+
+class CrxMakeTest < Test::Unit::TestCase
+  def setup
+    @dir = File.expand_path('tmp')
+    FileUtils.mkdir @dir
+    # chromefullfeed compile
+    open("http://chromefullfeed.googlecode.com/files/package.tar") do |file|
+      File.open(File.join(@dir, 'package.tar'), 'wb') do |f|
+        f << file.read
+      end
+    end
+    system("tar -xf #{File.join(@dir, "package.tar")} -C #{@dir}")
+  end
+  def teardown
+    FileUtils.rm_rf @dir
+  end
+  def test_create_crx
+    CrxMake.make(
+      :ex_dir => File.join(@dir, 'src'),
+      :pkey_output => File.join(@dir, 'test.pem'),
+      :crx_output => File.join(@dir, 'test.crx'),
+      :verbose => true,
+      :ignorefile => /\.swp$/,
+      :ignoredir => /^\.(?:svn|git|cvs)$/
+    )
+    assert(File.exist?(File.join(@dir, 'test.crx')))
+    assert(File.exist?(File.join(@dir, 'test.pem')))
+  end
+end
+

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: Constellation-crxmake
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Constellation
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-11 00:00:00 -07:00
+default_executable: crxmake
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: zipruby
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.3.2
+    version: 
+description: make chromium extension
+email: utatane.tea@gmail.com
+executables: 
+- crxmake
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- Rakefile
+- bin/crxmake
+- test/crxmake_test.rb
+- lib/crxmake.rb
+has_rdoc: false
+homepage: http://github.com/Constellation/crxmake/tree/master
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+- --charset
+- utf-8
+- --line-numbers
+- --inline-source
+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: "0"
+  version: 
+requirements: []
+
+rubyforge_project: crxmake
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: make chromium extension
+test_files: 
+- test/crxmake_test.rb