fastlib 0.0.7 → 0.0.8

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MjVjMmZmODA5NzE3NmM4ZGY3NDZlZmZmZTQ2MDE0NzdjZmIxM2I0Mg==
+  data.tar.gz: !binary |-
+    YjIxMGY0NWYyZTRiZWRlOTJlMzg3MGMzMmRjMmM4YzI4NjgyZjkzNQ==
+SHA512:
+  metadata.gz: !binary |-
+    MWQwYzczYzQ1ZmM5ZTJkZmZkOWI0NzQ0ZWU5MDU1ZDY5MjgwMGQwYzcxNzA5
+    YmM0MmVkYmNkMjBhYjI3MTI2ZTdlY2I5NzhjOWI2OWYwOTBmZWY5M2FiYTc0
+    NzFjMTNjZmM5YzgwZmM0YzVkZGYwNTcyZTJhYmE3YjQ4MDg1YjA=
+  data.tar.gz: !binary |-
+    OGQ3ZGNiMDRlNmNiNDlkMjVlZmNlMGQ0MWE5MGE3MzdlMjAzNjZiOTE3NDNh
+    ZmZkYmU2MDI5YjY3NDNkNjQ1NWY4ODQ5YjViYjIzODBlOWQ4ZmU4ZTU5NWUx
+    ZTVhMDQzMTM2YmZiYTEyMTI0ODE0OWUyNjZkMzRmZWRkOTBiM2Y=

data/README.markdown

@@ -6,26 +6,25 @@ This is similar to capabilities like zip/ziprequire, except that it provides wor
 
 # Usage
 
-$ apt-get install fastlib
+    $ gem install fastlib
 
 ## Store a library structure into FASTLIB archive
-$ \`gem env gemdir\`/gems/fastlib-\*/lib/fastlib.rb store 00000000 myarchive.fastlib lib/ lib/\*
-$ rm -rf lib
+    $ fastlib create mylib.fastlib /path/to/mylib
 
 ## Use that archive just by including the containing directory
-$ ruby -r rubygems -r fastlib -I. ./app.rb
+    $ ruby -r fastlib -I . ./myapp.rb
 
 ## Store a library structure into a FASTLIB archive with compression
-$ \`gem env gemdir\`/gems/fastlib-\*/lib/fastlib.rb store 00000001 myarchive.fastlib lib/ lib/\*
+    $ fastlib create -c mylib.fastlib /path/to/mylib
 
 ## Store a library structure into a FASTLIB archive with default "encryption"
-$ \`gem env gemdir\`/gems/fastlib-\*/lib/fastlib.rb store 00000002 myarchive.fastlib lib/ lib/\*
+    $ fastlib create -e 0 mylib.fastlib /path/to/mylib
 
 ## Store a library structure into a FASTLIB archive with default "encryption" and compression
-$ \`gem env gemdir\`/gems/fastlib-\*/lib/fastlib.rb store 00000003 myarchive.fastlib lib/ lib/\*
+    $ fastlib create -c -e 0 mylib.fastlib /path/to/mylib
 
 ## Store a library structure into a FASTLIB archive with custom encryption and compression
-$ ruby -I . -r mycrypto.rb \`gem env gemdir\`/gems/fastlib-\*/lib/fastlib.rb store 13370003 myarchive.fastlib lib/ lib/\*
+    $ fastlib create -I . -r mycrypto -c 0 -e 0x1337 mylib.fastlib /path/to/mylib
 
 $ cat mycrypto.rb
 
@@ -33,11 +32,11 @@ $ cat mycrypto.rb
     
     class FastLib
     
-        def self.encrypt_13370000(data)
+        def self.encrypt_00133700(data)
 	        # Encrypt
         end
     
-        def self.decrypt_13370000(data)
+        def self.decrypt_00133700(data)
 	        # Decrypt
         end
     
@@ -45,4 +44,4 @@ $ cat mycrypto.rb
 
 
 # Credits
-Rapid7 LLC
+Rapid7, Inc.

data/bin/fastlib

@@ -0,0 +1,122 @@
+#!/usr/bin/env ruby
+
+$:.unshift(File.expand_path(File.join(File.dirname(__FILE__), "..", "lib")))
+
+require 'fastlib'
+require 'optparse'
+require 'ostruct'
+
+options = OpenStruct.new(action: nil, archive: nil, required: nil, included: nil, compress: nil, encrypt: nil, verbose: nil)
+
+option_parser = OptionParser.new do |opts|
+  opts.banner = "Usage: #{$0} <action> [options] <arguments>"
+  opts.separator "Create or list the contents of a fastlib archive"
+  opts.separator ""
+  opts.separator "Examples"
+  opts.separator "  fastlib create mylib.fastlib mylib/"
+  opts.separator "  fastlib create -c mylib_compressed.fastlib mylib/"
+  opts.separator "  fastlib create -c -e 0 mylib_compressed_encrypted.fastlib mylib/"
+  opts.separator "  fastlib create -c -e 0x4444 -I /my/crypto/lib -r mycrypto mylib_compressed_encrypted_custom.fastlib mylib/"
+  opts.separator "  fastlib list mycompressed.fastlib"
+  opts.separator ""
+  opts.separator "Options"
+
+  opts.on("-c", "--compress", "Compresses the archive with Zlib ") do 
+    options.compress = true
+  end
+
+  opts.on("-e", "--encrypt 0x<Algorithm ID>", "Encrypt the archive with the specified algorithm ID (0x00 for XOR)") do |opt_encrypt|
+    if opt_encrypt =~ /^0x/
+      options.encrypt = opt_encrypt.to_i(16)
+    else
+      options.encrypt = opt_encrypt.to_i
+    end
+
+    if options.encrypt > 0xffffff
+      $stderr.puts "Error: Algorithm IDs must be between 0 and 0xffffff"
+      exit(1)
+    end
+  end
+
+  opts.on("-r", "--require library", "Require the specified library to support custom encryption methods") do |opt_require|
+    options.required ||= []
+    options.required << opt_require
+  end
+
+  opts.on("-I", "--include library_path", "Search the specified path for required libraries") do |opt_include|
+    $:.append opt_include
+  end
+
+  opts.on("-V", "--version", "Show the FastLib version") do
+    $stderr.puts "FastLib v#{FastLib::VERSION}"
+    exit(0)
+  end
+
+  opts.on("-h", "--help", "Show this message.") do
+    $stderr.puts opts
+    exit(1)
+  end
+end
+option_parser.parse!(ARGV)
+
+# Load any libraries required to support custom encryption providers
+if options.required
+  options.required.each {|lname| require(lname) }
+end
+
+if options.encrypt
+  # Verify that our 24-bit algorithm ID maps to a FastLib namespace method
+  # The user may need to specify -r provider to load the right library first
+  unless FastLib.respond_to?(sprintf("encrypt_%.8x", (options.encrypt<<8) ))
+    $stderr.puts "Error: Unknown algorithm ID, you may need to specify the provider library with -r"
+    exit(1)
+  end
+end
+
+options.action  = ARGV.shift
+options.archive = ARGV.shift
+
+unless options.archive
+  $stderr.puts "Error: No archive file has been specified"
+  exit(1)
+end
+
+case options.action
+when 'create'
+  
+  source_path = ARGV.shift
+  
+  unless source_path
+    $stderr.puts "Error: No source directory has been specified"
+    exit(1)    
+  end
+  
+  source_path  = File.expand_path(source_path)
+  source_files = Dir["#{source_path}/*"]
+  
+  create_flags = 0
+  
+  if options.compress
+    create_flags |= FastLib::FLAG_COMPRESS
+  end
+
+  if options.encrypt
+    create_flags |= (options.encrypt<<8)
+    create_flags |= FastLib::FLAG_ENCRYPT
+  end
+
+  FastLib.create(options.archive, create_flags, source_path, *source_files)
+
+when 'list'
+  $stdout.puts "Library: #{options.archive}"
+  $stdout.puts "====================================================="
+  FastLib.list(options.archive).each do |name|
+    fsize = FastLib.cache[options.archive][name][1]
+    ftime = ::Time.at(FastLib.cache[options.archive][name][2]).strftime("%Y-%m-%d %H:%M:%S")
+    $stdout.puts sprintf("%9d\t%20s\t%s\n", fsize, ftime, name)
+  end
+  $stdout.puts ""
+else
+  $stderr.puts "Error: Unknown action '#{options.action}'"
+  exit(1)
+end

data/fastlib.gemspec

@@ -0,0 +1,22 @@
+# encoding: utf-8
+
+APP_NAME = "fastlib"
+VERSION = "0.0.8"
+
+Gem::Specification.new do |s|
+	s.name                  = APP_NAME
+	s.version               = VERSION
+	s.homepage              = "https://github.com/rapid7/fastlib"
+	s.summary               = "FASTLIB archive library"
+	s.description           = "This gem provides a way to load libraries from an archive"
+	s.license               = "BSD"
+	s.authors               = ["HD Moore"]
+	s.email		              = ["hdm@rapid7.com"]
+	s.files                 = `git ls-files`.split("\n")
+  s.test_files            = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables           = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths         = ['lib']
+	s.extra_rdoc_files      = ["README.markdown"]
+	s.required_ruby_version = ">= 1.9.3"
+	s.platform              = "ruby"
+end

data/lib/fastlib.rb

@@ -11,18 +11,10 @@
 # AV-resistance of the Metasploit Framework and Rex libraries.
 #
 
-
-#
-# This library is still in its early form; a large number of performance and
-# compatiblity improvements are not yet included. Do not depend on the FASTLIB
-# file format at this time.
-#
-
 require "find"
 
-
 #
-# Copyright (C) 2011 Rapid7. You can redistribute it and/or
+# Copyright (C) 2011-2014 Rapid7, Inc. You can redistribute it and/or
 # modify it under the terms of the ruby license.
 #
 # 
@@ -37,7 +29,7 @@ require "find"
 #
 class FastLib
 
-	VERSION = "0.0.7"
+	VERSION = "0.0.8"
 
 	FLAG_COMPRESS = 0x01
 	FLAG_ENCRYPT  = 0x02
@@ -187,7 +179,7 @@ class FastLib
 	# directory that should be excluded from the archived path, and finally
 	# the list of specific files and directories to include in the archive.
 	#
-	def self.dump(lib, flag, bdir, *dirs)
+	def self.create(lib, flags, bdir, *dirs)
 		head = ""
 		data = ""
 		hidx = 0
@@ -196,8 +188,16 @@ class FastLib
 		bdir = bdir.gsub(/\/$/, '')
 		brex = /^#{Regexp.escape(bdir)}\//
 		
+		if flags.kind_of?(::String)
+			if flags =~ /^0x/
+				flags = flags.to_i(16)
+			else
+				flags = flags.to_i
+			end
+		end
+
 		@@cache[lib] = {
-			:fastlib_flags => flag.to_i(16)
+			:fastlib_flags => flags
 		}
 		
 		dirs.each do |dir|
@@ -210,7 +210,6 @@ class FastLib
 					buff = fastlib_filter_encode(lib, fd.read(fd.stat.size))
 				end
 				
-
 				head << [ name.length, didx, buff.length, ::File.stat(path).mtime.utc.to_i ].pack("NNNN")
 				head << name
 				hidx = hidx + 16 + name.length
@@ -224,14 +223,14 @@ class FastLib
 		
 		::File.open(lib, "wb") do |fd|
 			fd.write("FAST")
-			fd.write( [ head.length, flag.to_i(16) ].pack("NN") )
+			fd.write( [ head.length, flags ].pack("NN") )
 			fd.write( head )
 			fd.write( data )
 		end	
 	end
 	
 	#
-	# This archive provides a way to list the contents of an archive
+	# This method provides a way to list the contents of an archive
 	# file, returning the names only in sorted order.
 	#
 	def self.list(lib)
@@ -240,8 +239,8 @@ class FastLib
 	end
 	
 	#
-	# This method is called on the loaded is required to expand __FILE__
-	# and other inline dynamic constants to map to the correct location.
+	# This method is expands __FILE__ sequences and other inline dynamic constants
+	# to map to the correct location.
 	#
 	def self.post_process(lib, name, data)
 		data.gsub('__FILE__', "'#{ ::File.expand_path(::File.join(::File.dirname(lib), name)) }'")
@@ -277,51 +276,6 @@ class FastLib
 end
 
 
-#
-# Allow this library to be used as an executable to create and list
-# FASTLIB archives
-#
-if __FILE__ == $0
-	cmd = ARGV.shift
-	unless ["store", "list", "version"].include?(cmd)
-		$stderr.puts "Usage: #{$0} [dump|list|version] <arguments>"
-		exit(0)
-	end
-	
-	case cmd
-	when "store"
-		dst = ARGV.shift
-		flg = ARGV.shift
-		dir = ARGV.shift
-		src = ARGV
-		unless dst and dir and src.length > 0
-			$stderr.puts "Usage: #{$0} store destination.fastlib flags base_dir src1 src2 ... src99"
-			exit(0)
-		end
-		FastLib.dump(dst, flg, dir, *src)
-	
-	when "list"
-		src = ARGV.shift
-		unless src
-			$stderr.puts "Usage: #{$0} list"
-			exit(0)
-		end
-		$stdout.puts "Library: #{src}"
-		$stdout.puts "====================================================="
-		FastLib.list(src).each do |name|
-			fsize = FastLib.cache[src][name][1]
-			ftime = ::Time.at(FastLib.cache[src][name][2]).strftime("%Y-%m-%d %H:%M:%S")
-			$stdout.puts sprintf("%9d\t%20s\t%s\n", fsize, ftime, name)
-		end
-		$stdout.puts ""
-
-	when "version"
-		$stdout.puts "FastLib Version #{FastLib.version}"
-	end
-	
-	exit(0)
-end
-
 #
 # FASTLIB archive format (subject to change without notice)
 #
@@ -339,6 +293,7 @@ end
 
 	4 bytes: "FAST"
 	4 bytes: NBO header length
+	4 bytes: NBO flags (24-bit crypto ID, 8 bit modes)
 	[
 		4 bytes: name length (0 = End of Names)
 		4 bytes: data offset

metadata

@@ -1,72 +1,52 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: fastlib
-version: !ruby/object:Gem::Version 
-  hash: 17
-  prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 7
-  version: 0.0.7
+version: !ruby/object:Gem::Version
+  version: 0.0.8
 platform: ruby
-authors: 
+authors:
 - HD Moore
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-11-23 00:00:00 -06:00
-default_executable: 
+date: 2014-09-07 00:00:00.000000000 Z
 dependencies: []
-
 description: This gem provides a way to load libraries from an archive
-email: 
-- hdm@metasploit.com
-executables: []
-
+email:
+- hdm@rapid7.com
+executables:
+- fastlib
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README.markdown
-files: 
+files:
 - README.markdown
 - Rakefile
+- bin/fastlib
+- fastlib.gemspec
 - lib/fastlib.rb
-has_rdoc: true
 homepage: https://github.com/rapid7/fastlib
-licenses: 
+licenses:
 - BSD
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 57
-      segments: 
-      - 1
-      - 8
-      - 7
-      version: 1.8.7
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.4.2
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: FASTLIB archive library
 test_files: []
-
+has_rdoc: