ooxml_decrypt 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 84f71ccf2d737f1b14169099dfaae2d12bbc2ab527a97c44b84670d682b598be
-  data.tar.gz: 5ed8efac3dffe9e9b2863443c5cf8a2fdb0a58c27f3e1f0156eeab9305bb3f42
+SHA1:
+  metadata.gz: 6d07cc929ff8df49738470666db236138fd7f0ea
+  data.tar.gz: 5f64c2484844484959f5bfa03b868262d9096f2e
 SHA512:
-  metadata.gz: 30fe6f7b9acbbaf6237cc34dd4d54730c88a695834f08196a8bcc0f15217c018a5efee7cf596efe2071dc0cd06957dc9262b32e0560e0fe1151800648aeb34d5
-  data.tar.gz: a9a54b23a57528592bd41cdcdee322787cf0d45b0a4fbcf46fd8986cc9adda371f3688d8fbc8b52715fb662af695c02d28b806b9efc3c1b357fe960b5d138ff1
+  metadata.gz: 2d5849be67cc23e5b3ade74a84a2f388b7eb97f1e71c0537a834a777fd80cca1dd147bf82aaef159537909e2f51001deb2ff150750b4aeaf0f103025d9d68d57
+  data.tar.gz: b4a8c4af8c921499294808a81b5e3f9a4c723df9f939ccc5a8a7b8d9acc7650cbe61665e786c74d8f63c34750c7ff44378a13473141ba13073ce6d71002cf3a3

data/.gitignore

@@ -33,3 +33,6 @@ Gemfile.lock
 
 # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
 .rvmrc
+
+# rspec failure tracking
+.rspec_status

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+## [Unreleased]
+*no unreleased changes*
+
+## 1.0.0 / 2019-05-08
+### Added
+* Added Installation and Usage instructions to the README
+
+### Changed
+* Moved the executable, removing the .rb file extention and added a shebang

data/README.md

@@ -1,9 +1,59 @@
-# ooxml_decrypt [![Build Status](https://travis-ci.org/woodbusy/ooxml_decrypt.svg?branch=master)](https://travis-ci.org/woodbusy/ooxml_decrypt)
+# OoxmlDecrypt [![Build Status](https://travis-ci.org/woodbusy/ooxml_decrypt.svg?branch=master)](https://travis-ci.org/woodbusy/ooxml_decrypt)
 
 A Ruby library and script for decrypting password-protected Microsoft Office XML files (.docx, .xlsx, etc.), which use the OOXML format. There are many tools available for working with OOXML files without Office, but a password-protected document typically requires an Office installation to decrypt. This pure-Ruby, standalone library and script can decrypt Office files without an Office installation.
 
 At present, this only supports documents encrypted (i.e. password-protected) by Office 2010 or later. Office 2007 also uses XML, but the encryption settings are a bit different.
 
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ooxml_decrypt'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ooxml_decrypt
+
+## Usage
+
+### Command Line Tool
+
+If you installed the gem using Bundler, execute:
+
+    $ bundle exec ooxml_decrypt --source <path> --destination <path> --password <password>
+
+otherwise use:
+
+    $ ooxml_decrypt --source <path> --destination <path> --password <password>
+
+### Within your code
+
+To decrypt a file programatically:
+
+```ruby
+require 'ooxml_decrypt'
+
+encrypted_path = ...
+decrypted_path = ...
+# Ensure password is a binary representation of a UTF-16LE string
+binary_password = password.encode("utf-16le")
+                          .bytes.pack("c*")
+                          .encode("binary")
+
+OoxmlDecrypt::EncryptedFile.decrypt_to_file(encrypted_path, binary_password, decrypted_path)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/{bin/decrypt_ooxml.rb → exe/decrypt_ooxml}

@@ -1,3 +1,5 @@
+#!/usr/bin/env ruby
+
 $LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + "/../lib"))
 
 require "ooxml_decrypt"

data/lib/ooxml_decrypt.rb

@@ -1,3 +1,4 @@
 require "ooxml_decrypt/key_data"
 require "ooxml_decrypt/encrypted_key"
 require "ooxml_decrypt/encrypted_file"
+require "ooxml_decrypt/version"

data/lib/ooxml_decrypt/version.rb

@@ -0,0 +1,4 @@
+# This stores the current version of the OoxmlDecrypt gem
+module OoxmlDecrypt
+  VERSION = '1.0.0'.freeze
+end

data/ooxml_decrypt.gemspec

@@ -1,20 +1,30 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ooxml_decrypt/version"
+
 Gem::Specification.new do |spec|
   spec.name = 'ooxml_decrypt'
-  spec.version = '0.1.0'
+  spec.version = OoxmlDecrypt::VERSION
   spec.authors = %w[woodbusy phish]
   spec.summary = 'Ruby library and script for decrypting password-protected ' \
                  'Microsoft Office XML files (.docx, .xlsx, etc.)'
   spec.homepage = 'https://github.com/woodbusy/ooxml_decrypt'
   spec.license = 'Apache-2.0'
 
-  spec.files = `git ls-files -z`.split("\x0").reject { |s| s =~ %r{^pkg/} }
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(bin|spec)/}) }
+  end
   spec.files -= %w[.travis.yml] # Not needed in the gem
-  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'nokogiri'
-  spec.add_dependency 'ruby-ole'
+  spec.add_dependency 'nokogiri', '~> 1.10'
+  spec.add_dependency 'ruby-ole', '~> 1.2'
 
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 12.3'
   spec.add_development_dependency 'rspec', '>= 2.11.0', '< 4.0'
 end

metadata

@@ -1,44 +1,72 @@
 --- !ruby/object:Gem::Specification
 name: ooxml_decrypt
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - woodbusy
 - phish
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2019-05-07 00:00:00.000000000 Z
+date: 2019-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.10'
 - !ruby/object:Gem::Dependency
   name: ruby-ole
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '12.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -62,30 +90,25 @@ dependencies:
 description: 
 email: 
 executables:
-- decrypt_ooxml.rb
+- decrypt_ooxml
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
-- bin/decrypt_ooxml.rb
+- Rakefile
+- exe/decrypt_ooxml
 - lib/ooxml_decrypt.rb
 - lib/ooxml_decrypt/encrypted_file.rb
 - lib/ooxml_decrypt/encrypted_key.rb
 - lib/ooxml_decrypt/key_data.rb
 - lib/ooxml_decrypt/key_info_base.rb
 - lib/ooxml_decrypt/string_helpers.rb
+- lib/ooxml_decrypt/version.rb
 - ooxml_decrypt.gemspec
-- spec/crypto_spec.rb
-- spec/encrypted_file_spec.rb
-- spec/examples/1qaz2wsx.xlsx
-- spec/examples/password.encrypted_package
-- spec/examples/password.encryption_info
-- spec/examples/password.xlsx
-- spec/examples/password.xlsx_decrypted
-- spec/spec_helper.rb
 homepage: https://github.com/woodbusy/ooxml_decrypt
 licenses:
 - Apache-2.0
@@ -105,17 +128,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubyforge_project: 
+rubygems_version: 2.5.2.3
 signing_key: 
 specification_version: 4
 summary: Ruby library and script for decrypting password-protected Microsoft Office
   XML files (.docx, .xlsx, etc.)
-test_files:
-- spec/crypto_spec.rb
-- spec/encrypted_file_spec.rb
-- spec/examples/1qaz2wsx.xlsx
-- spec/examples/password.encrypted_package
-- spec/examples/password.encryption_info
-- spec/examples/password.xlsx
-- spec/examples/password.xlsx_decrypted
-- spec/spec_helper.rb
+test_files: []

data/spec/crypto_spec.rb

@@ -1,46 +0,0 @@
-require "spec_helper"
-
-module OoxmlDecrypt
-  describe "When testing decryption" do
-    let(:encrypted_key) do
-      EncryptedKey.new( :spin_count => 100_000,
-                        :block_size => 16,
-                        :key_bits => 128,
-                        :cipher_algorithm => "AES",
-                        :cipher_chaining => "ChainingModeCBC",
-                        :hash_algorithm => "SHA1",
-                        :salt => "oksWUymFqdISO4t7krYTMQ==".base64_decode,
-                        :encrypted_key => "7fHCMYen4j6VmJtYiuoKdA==".base64_decode,
-                      )
-    end
-    let(:key_data) do
-      KeyData.new(  :block_size => 16,
-                    :key_bits => 128,
-                    :cipher_algorithm => "AES",
-                    :cipher_chaining => "ChainingModeCBC",
-                    :hash_algorithm => "SHA1",
-                    :salt => "O/HT8XgDoXnw+k9ts0Esxw==".base64_decode,
-                  )
-    end
-    let(:password) { "p\0a\0s\0s\0w\0o\0r\0d\0" }
-
-#    it "should generate a key-decryption key" do
-#      key_encryption_key = encrypted_key.key_encryption_key(password)
-#      expect( key_encryption_key.hexify ).to eql("1a1f6755f5a4f216023707fa3c986502")
-#    end
-
-    it "should decrypt a symmetric key" do
-      expect( encrypted_key.key(password).hexify ).to eql("c965e405bc4183399e038d3784d26f93")
-    end
-
-    it "should decrypt an entire encrypted package stream" do
-      encrypted_package = File.read("spec/examples/password.encrypted_package", :encoding => 'binary')
-      plaintext = key_data.decrypt_encrypted_package_stream( encrypted_package, encrypted_key.key(password) )
-      expect(plaintext[0,16].hexify).to eql("504b0304140006000800000021009745")
-      expect(plaintext[-16,16].hexify).to eql("0000090009003e020000731b00000000")
-
-      expected_plaintext = File.read("spec/examples/password.xlsx_decrypted", :encoding => "binary")
-      expect(plaintext.hexify).to eql(expected_plaintext.hexify)
-    end
-  end
-end

data/spec/encrypted_file_spec.rb

@@ -1,17 +0,0 @@
-require "spec_helper"
-
-module OoxmlDecrypt
-  describe EncryptedFile do
-    it "should decrypt an encrypted XLSX" do
-      password = "p\0a\0s\0s\0w\0o\0r\0d\0"
-      filename = "spec/examples/password.xlsx"
-      plaintext = EncryptedFile.decrypt(filename, password)
-
-      expect(plaintext[0,16].hexify).to eql("504b0304140006000800000021009745")
-      expect(plaintext[-16,16].hexify).to eql("0000090009003e020000731b00000000")
-
-      expected_plaintext = File.read("spec/examples/password.xlsx_decrypted", :encoding => "binary")
-      expect(plaintext.hexify).to eql(expected_plaintext.hexify)
-    end
-  end
-end

data/spec/spec_helper.rb

@@ -1,2 +0,0 @@
-require "ooxml_decrypt"
-require "ooxml_decrypt/string_helpers"