simple_cfb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fb633f279a321bfeb12a1e48f65bcd709c90766c7e04a76cb9b57a6957479423
+  data.tar.gz: 3ad1c95d55512f300b3964a392a8f5981420a096dd20c16840f1117d6b90fe8f
+SHA512:
+  metadata.gz: dd0c52b2937ed934722c19ae0a3e2544b2b68f3e072527060c4df84480e82e2014ef777a8a3c955257d65cc8e2176d7db1eefb38fcd816fcd720e23a888c13d5
+  data.tar.gz: c27c1f22e94c9d62ea865f296bc34bacd947510828dfd109daecd18738a22b269add8fb8f44130092f8cfc09c45a2750e59fdc84c3c48cc84ed85a1b9721f968

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright (C) 2022-present RIPA Global
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,146 @@
+# SimpleCFB
+
+[![License](https://img.shields.io/badge/license-Apache%202-blue)](https://opensource.org/licenses/Apache-2.0)
+[![Build Status](https://github.com/RIPAGlobal/simple_cfb/actions/workflows/ruby.yml/badge.svg)](https://github.com/RIPAGlobal/simple_cfb/actions)
+
+## Overview
+
+SimpleCFB implements ways to read and write CFB files in pure Ruby. It is a port of parts of:
+
+* https://github.com/SheetJS/js-cfb
+
+CFB (Container File Binary) is a Microsoft-originated container format based on FAT:
+
+* https://docs.microsoft.com/en-us/openspecs/windows_protocols/ms-cfb/
+
+CFB files are used to wrap OOXML data when an Excel spreadsheet is encrypted with a password. Support for encrypted OOXML files in Ruby was the primary reason for creating the Simple CFB gem. If you're interested in that, then https://github.com/RIPAGlobal/ooxml_encryption may be of interest.
+
+
+
+## Installation
+
+Install the gem and add to the application's `Gemfile` by executing:
+
+    $ bundle add simple_cfb
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install simple_cfb
+
+
+
+## Usage
+### Writing a file
+
+Create a new CFB object.
+
+```ruby
+require 'simple_cfb'
+
+cfb = SimpleCfb.new
+```
+
+Add files by filename. Filenames can be given in any valid string encoding, but are **limited to 31 characters** maximum and can only use characters which can be **transcoded into UTF-16**. File data is given an `ASCII-8BIT` encoded string which is not interpreted or modified in any way. Use of folders (via filenames including a `/` separator) are theoretically supported but not tested and, therefore, discouraged.
+
+```ruby
+cfb.add('SomeFilename', file_data)
+cfb.add('AnotherFile',  more_file_Data)
+```
+
+"Write" the CFB object contents into a single compiled object, returned as an `ASCII-8BIT` encoded string. You can then write this to a file using normal Ruby methods. Note that binary writing must be selected (`wb` mode) to avoid corruption.
+
+```ruby
+output = cfb.write()
+
+File.open('/path/to/output.cfb', 'wb') do | file |
+  file.write(output)
+end
+```
+
+### Reading a file
+
+Create a new CFB object.
+
+```ruby
+cfb = SimpleCfb.new
+```
+
+"Parse" an input file into the CFB data, updating the object. Note that binary reading (`rb` mode) must be used. If you already have something
+like an ASCII-8BIT encoded string and want to parse that instead, you can wrap it in a StringIO - e.g. `cfb.parse!(StringIO.new(str))`.
+
+```ruby
+File.open('/path/to/input.cfb', 'rb') do | file |
+  cfb.parse!(file)
+end
+```
+
+The CFB object's files can now be examined through properties `file_index` and `full_paths` - two arrays that give information on the files in the container, read as pairs with the same index in each array referring to the same file entry. Index 0 always contains the root object and index 1 contains an entry with a strange filename derived from `SheetJS`; these can be safely ignored, with the `SheetJS` entry in particular included only for intentional binary-level parity with the original JavaScript source code from which SimpleCFB was created.
+
+The file index entries are of most interest; you can search the array entries by `name` property values and obtain file data from the `content` properties as `ASCII-8BIT` encoded strings. For example, given this:
+
+```ruby
+require 'simple_cfb'
+
+cfb_writer = SimpleCfb.new
+cfb_writer.add('hello.txt', '1234')
+
+cfb_data = cfb_writer.write()
+#=> "\xD0\xCF\x11..."
+
+cfb_reader = SimpleCfb.new
+cfb_reader.parse!(StringIO.new(cfb_data))
+
+cfb_reader.full_paths
+# => ["Root Entry/", "Root Entry/\u0001Sh33tJ5", "Root Entry/hello.txt", "/"]
+
+cfb_reader.file_index
+# => [
+#  <OpenStruct name="Root Entry/", ...>,
+#  <OpenStruct name="\u0001Sh33tJ5", ...>,
+#  <OpenStruct name="hello.txt", ..., content="1234">,
+#  <OpenStruct name="/" ...]
+```
+
+...then you could extract data for a specific file via `Array#find` using `name`. Note that the CFB `UTF-16LE`-encoded filenames are re-encoded to UTF-8 for convenience, so you don't need to worry about that when comparing names:
+
+```
+file_entry = cfb_reader.file_index.find { |f| f.name == 'hello.txt' }
+file_data  = file_entry.content
+# => "1234"
+```
+
+
+
+## Resource overhead
+
+Due to the nature of the original file format, which has various tables written at the start of the file that can only be built once the file contents are known, CFB files have to be compiled or parsed in RAM. Streamed output or input is not possible. Attempting to create or read large CFB files is therefore not recommended - there could be very large RAM requirements arising.
+
+
+
+## Other notes
+
+Coding style is atypical for Ruby, which simply reflects the style of the original JavaScript sources. Most of the time it's a close copy of the original with several sections that I didn't even understand and simply transcribed to Ruby.
+
+Verification involved reading and writing files output by the original JavaScript source code, then comparing binary results with the Ruby port. Bugs are likely, in both the original code given its opacity and in the Ruby port given the likelihood of transcription errors. It suffices for the encrypted OOXML original use case; the code coverage report from running tests shows some significant gaps.
+
+
+
+## Development
+
+Use `bundle exec rspec` to run tests. 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`. If you have sufficient RubyGems access to release a new version, update the version number and date in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+Locally generated RDoc HTML seems to contain a more comprehensive and inter-linked set of pages than those available from `rubydoc.info`. You can (re)generate the internal [`rdoc` documentation](https://ruby-doc.org/stdlib-2.4.1/libdoc/rdoc/rdoc/RDoc/Markup.html#label-Supported+Formats) with:
+
+```shell
+bundle exec rake rerdoc
+```
+
+...yes, that's `rerdoc` - Re-R-Doc - then open `docs/rdoc/index.html`.
+
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/RIPAGlobal/simple_cfb.

data/Rakefile

@@ -0,0 +1,17 @@
+require 'rake'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rdoc/task'
+require 'sdoc'
+
+RSpec::Core::RakeTask.new(:default) do | t |
+end
+
+Rake::RDocTask.new do | rd |
+  rd.rdoc_files.include('README.md', 'lib/**/*.rb')
+
+  rd.title     = 'SimpleCFB'
+  rd.main      = 'README.md'
+  rd.rdoc_dir  = 'docs/rdoc'
+  rd.generator = 'sdoc'
+end