ooxml_crypt 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 64e15ec061f119a4cd42d96bf9d78379ab414baac2a7cf112c1949dd2c8cf7dd
+  data.tar.gz: 8d2d7db90bf52b382930d39fb0cd1070d354b40554a02b77dda4bea37ba3d919
+SHA512:
+  metadata.gz: a750fccb3208adafc918e7b215875348e6c8afd372a759d8d3eb8eb89fc4c11225b7a4e2f3cdb0ba0dab938a33c9513e1489c48edd1160a66463a8acb6fedaac
+  data.tar.gz: 47abbf6cb88ec6eedea69c89fa10cb743d36b14c1e71d4567afa4771364b5aa4273a71f57c96cb96ec39f19087f18efbd2c68e88c1be175fb24fdd14afbc3a32

data/Gemfile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Ashish Kulkarni
+
+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/README.md

@@ -0,0 +1,58 @@
+# OoxmlCrypt
+
+A Ruby library for encrypting/decrypting password-protected Microsoft Office XML (OOXML) files (e.g. .docx, .xlsx, .pptx). This is a native extension that builds on top of [the msoffice library](https://github.com/herumi/msoffice). This only supports documents encrypted (i.e. password-protected) by Office 2010 or later.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ooxml_crypt'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install ooxml_crypt
+
+## Usage
+
+To encrypt, you can either pass in a file or binary data:
+```ruby
+require "ooxml_crypt"
+
+# pass in binary data, get binary data
+encrypted_data = OoxmlCrypt.encrypt(bindata, password)
+
+# or use file names
+OoxmlCrypt.encrypt_file(filename, password, encrypted_filename)
+```
+
+The same approach holds true for decryption:
+```ruby
+require "ooxml_crypt"
+
+# pass in binary data, get binary data
+decrypted_data = OoxmlCrypt.decrypt(bindata, password)
+
+# or use file names
+OoxmlCrypt.decrypt_file(filename, password, decrypted_filename)
+```
+
+An exception `OoxmlCrypt::Error` will be raised in case of errors.
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/teamsimplepay/ooxml_crypt.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/extensiontask"
+
+task build: :compile
+
+Rake::ExtensionTask.new("ooxml_crypt") do |ext|
+  ext.lib_dir = "lib/ooxml_crypt"
+end
+
+task default: %i[clobber compile]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "ooxml_crypt"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/ext/ooxml_crypt/extconf.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "mkmf"
+
+# force usage of the C++ compiler
+have_library("stdc++")
+
+# check for OpenSSL
+abort("Please install OpenSSL development libraries!") unless have_header("openssl/hmac.h") && have_library("crypto")
+
+# setup build configuration
+vendor = File.realpath(File.join(__dir__, "..", "..", "vendor"))
+$INCFLAGS << " -I#{vendor}/cybozulib/include -I#{vendor}/msoffice/include"
+$VPATH << "#{vendor}/msoffice/src"
+$srcs = ["ooxml_crypt.c", "msocdll.cpp"]
+
+# create makefile
+create_makefile("ooxml_crypt/ooxml_crypt")

data/ext/ooxml_crypt/ooxml_crypt.c

@@ -0,0 +1,27 @@
+#include "ooxml_crypt.h"
+
+VALUE rb_encrypt_file(VALUE self, VALUE inFile, VALUE password, VALUE outFile)
+{
+  char *out  = StringValueCStr(outFile);
+  char *in   = StringValueCStr(inFile);
+  char *pass = StringValueCStr(password);
+
+  return INT2FIX(MSOC_encryptA(out, in, pass, NULL));
+}
+
+VALUE rb_decrypt_file(VALUE self, VALUE inFile, VALUE password, VALUE outFile)
+{
+  char *out  = StringValueCStr(outFile);
+  char *in   = StringValueCStr(inFile);
+  char *pass = StringValueCStr(password);
+
+  return INT2FIX(MSOC_decryptA(out, in, pass, NULL));
+}
+
+void Init_ooxml_crypt(void)
+{
+  VALUE mod = rb_define_module("OoxmlCryptNative");
+
+  rb_define_module_function(mod, "encrypt_file", rb_encrypt_file, 3);
+  rb_define_module_function(mod, "decrypt_file", rb_decrypt_file, 3);
+}

data/ext/ooxml_crypt/ooxml_crypt.h

@@ -0,0 +1,7 @@
+#ifndef OOXML_CRYPT_H
+#define OOXML_CRYPT_H 1
+
+#include "ruby.h"
+#include "msoc.h"
+
+#endif /* OOXML_CRYPT_H */

data/lib/ooxml_crypt/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module OoxmlCrypt
+  VERSION = "0.1.0"
+end

data/lib/ooxml_crypt.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require_relative "ooxml_crypt/version"
+require_relative "ooxml_crypt/ooxml_crypt"
+
+require "tempfile"
+
+module OoxmlCrypt
+  class Error < StandardError; end
+  class FileNotFound < Error; end
+  class EmptyPassword < Error; end
+
+  ERRORS = { # should be kept in sync with msoc.h
+    1  => "not supported format",
+    2  => "already encrypted",
+    3  => "already decrypted",
+    4  => "bad password",
+    5  => "bad parameter",
+    6  => "small max size",
+    7  => "no memory",
+    8  => "internal exception",
+    9  => "too large file",
+    10 => "inFile is empty",
+    11 => "outFile is empty",
+    12 => "password is empty",
+  }
+
+  def self.encrypt_file(input, password, output)
+    raise EmptyPassword if password.nil? || password.empty?
+    raise FileNotFound, input unless File.exist?(input)
+
+    result = OoxmlCryptNative.encrypt_file(input, password, output)
+    raise Error, ERRORS[-result] if result != 0
+  end
+
+  def self.decrypt_file(input, password, output)
+    raise EmptyPassword if password.nil? || password.empty?
+    raise FileNotFound, input unless File.exist?(input)
+
+    result = OoxmlCryptNative.decrypt_file(input, password, output)
+    raise Error, ERRORS[-result] if result != 0
+  end
+
+  def self.encrypt(data, password)
+    with_temp_files(data) do |input, output|
+      encrypt_file(input, password, output)
+    end
+  end
+
+  def self.decrypt(data, password)
+    with_temp_files(data) do |input, output|
+      decrypt_file(input, password, output)
+    end
+  end
+
+  private
+
+  def self.with_temp_files(data)
+    input = Tempfile.new("ooxml_crypt_input", binmode: true)
+    input.write(data)
+    input.close
+
+    output = Tempfile.new("ooxml_crypt_output", binmode: true)
+    output.close
+
+    yield input.path, output.path
+
+    result = File.binread(output.path)
+
+    input.unlink
+    output.unlink
+
+    result
+  end
+end

data/vendor/cybozulib/.github/workflows/main.yml

@@ -0,0 +1,12 @@
+name: test
+on: [push]
+
+jobs:
+  build:
+    name: test
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - run: make test TRAVIS_TEST=1 TEST_OUTPUT=1 -j4
+    - run: make clean
+    - run: make test TRAVIS_TEST=1 TEST_OUTPUT=1 -j4 CXX=clang++

data/vendor/cybozulib/.gitignore

@@ -0,0 +1,5 @@
+CVS
+debug
+*.exe
+
+

data/vendor/cybozulib/CMakeLists.txt

@@ -0,0 +1,6 @@
+cmake_minimum_required(VERSION 2.6)
+project(cybozulib)
+
+file(GLOB headers include/cybozu/*.hpp)
+install(FILES ${headers} DESTINATION include/cybozu)
+

data/vendor/cybozulib/COPYRIGHT

@@ -0,0 +1,27 @@
+
+Copyright (c) 2007-2012 Cybozu Labs, Inc.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+Redistributions of source code must retain the above copyright notice, this
+list of conditions and the following disclaimer.
+Redistributions in binary form must reproduce the above copyright notice,
+this list of conditions and the following disclaimer in the documentation
+and/or other materials provided with the distribution.
+Neither the name of the Cybozu Labs, Inc. nor the names of its contributors may
+be used to endorse or promote products derived from this software without
+specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
+THE POSSIBILITY OF SUCH DAMAGE.

data/vendor/cybozulib/Makefile

@@ -0,0 +1,26 @@
+include common.mk
+
+all:
+	$(MKDIR) lib bin
+	$(MAKE) -C src
+	$(MAKE) -C test
+	$(MAKE) -C sample
+
+test:
+	$(MAKE) -C test test
+
+sample:
+	$(MAKE) -C sample
+
+clean:
+	$(MAKE) -C src clean
+	$(MAKE) -C test clean
+	$(MAKE) -C sample clean
+
+PREFIX?=/usr/local
+install:
+	$(MKDIR) $(PREFIX)/include/cybozu
+	cp -a include/cybozu/ $(PREFIX)/include/
+
+.PHONY: sample clean
+

data/vendor/cybozulib/common.mk

@@ -0,0 +1,116 @@
+GCC_VER=$(shell $(PRE)$(CC) -dumpversion)
+UNAME_S=$(shell uname -s)
+ifeq ($(UNAME_S),Linux)
+  OS=Linux
+endif
+ifeq ($(UNAME_S),Darwin)
+  CFLAGS+=-std=c++11 # clang
+else
+  LDFLAGS += -lrt
+endif
+CP = cp -f
+AR = ar r
+MKDIR=mkdir -p
+RM=rm -fr
+CFLAGS_OPT+=-fomit-frame-pointer -DNDEBUG
+ifeq ($(CXX),clang++)
+  CFLAGS_OPT+=-O3
+else
+  ifeq ($(shell expr $(GCC_VER) \> 4.6.0),1)
+    CFLAGS_OPT+=-Ofast
+  else
+    CFLAGS_OPT+=-O3
+  endif
+endif
+CFLAGS_WARN=-Wall -Wextra -Wformat=2 -Wcast-qual -Wcast-align -Wwrite-strings -Wfloat-equal -Wpointer-arith
+CFLAGS+= -g -D_FILE_OFFSET_BITS=64
+CFLAGS+=$(CFLAGS_WARN)
+BIT?=64
+ifeq ($(BIT),0)
+	BIT_OPT=
+else
+	BIT_OPT=-m$(BIT)
+endif
+CFLAGS+= $(BIT_OPT)
+LDFLAGS+= $(BIT_OPT)
+ifeq ($(MARCH),)
+ifeq ($(shell expr $(GCC_VER) \> 4.2.1),1)
+	CFLAGS+=-march=native
+endif
+else
+	CFLAGS+=$(MARCH)
+endif
+
+DEBUG=1
+ifeq ($(RELEASE),1)
+	DEBUG=0
+endif
+
+ifeq ($(DEBUG),0)
+  CFLAGS+=$(CFLAGS_OPT)
+  OBJDIR=release
+  OBJSUF=
+else
+  ifeq ($(OS),Linux)
+    LDFLAGS+=-rdynamic
+  endif
+  OBJDIR=debug
+  OBJSUF=d
+endif
+
+TOPDIR:=$(realpath $(dir $(lastword $(MAKEFILE_LIST))))/
+EXTDIR:=$(TOPDIR)../cybozulib_ext/
+
+####################################################
+
+CFLAGS+= -I$(TOPDIR)include
+LDFLAGS += -lz -lpthread -lssl -lcrypto
+HAS_BOOST=$(shell echo "\#include <boost/version.hpp>" | ($(CXX) -E - 2>/dev/null) | grep "boost/version.hpp" >/dev/null && echo "1")
+HAS_MECAB=$(shell echo "\#include <mecab.h>" | ($(CXX) -E - 2>/dev/null) | grep "mecab.h" >/dev/null && echo "1")
+HAS_EIGEN=$(shell echo "\#include <eigen3/Eigen/Sparse>" | ($(CXX) -E - 2>/dev/null) | grep "eigen3/Eigen/Sparse" >/dev/null && echo "1")
+ifeq ($(HAS_BOOST),1)
+  LDFLAGS += -lboost_regex
+endif
+ifeq ($(HAS_MECAB),1)
+  LDFLAGS += -lmecab
+endif
+
+####################################################
+
+MKDEP = sh -ec '$(PRE)$(CC) -MM $(CFLAGS) $< | sed "s@\($*\)\.o[ :]*@$(OBJDIR)/\1.o $@ : @g" > $@; [ -s $@ ] || rm -f $@; touch $@'
+
+CLEAN=$(RM) $(TARGET) $(OBJDIR)
+
+ifeq ($(TEST_OUTPUT),1)
+define UNIT_TEST
+sh -ec 'for i in $(TARGET); do echo $$i; $$i; done'
+endef
+else
+define UNIT_TEST
+sh -ec 'for i in $(TARGET); do $$i|grep "ctest:name"; done' > result.txt
+awk 'BEGIN{E=0} match($$0,/name=([^,]*),.*ng=([0-9]*), exception=([0-9]*)/,r){ if (r[2] +r[3] > 0) {system("$(TOPDIR)/bin/" r[1] ".exe"); E++}} END{if(E==0) {print("all unit tests succeed")}else{exit(1)}}' < result.txt
+endef
+endif
+
+define SAMPLE_TEST
+sh -ec 'for i in $(TARGET); do $$i; done'
+endef
+
+.SUFFIXES: .cpp .d .exe
+
+$(OBJDIR)/%.o: %.cpp
+	$(PRE)$(CXX) -c $< -o $@ $(CFLAGS)
+
+$(OBJDIR)/%.d: %.cpp $(OBJDIR)
+	@$(MKDEP)
+
+$(TOPDIR)bin/%$(OBJSUF).exe: $(OBJDIR)/%.o $(LIBS)
+	$(PRE)$(CXX) $< -o $@ $(LIBS) $(LDFLAGS)
+
+OBJS=$(addprefix $(OBJDIR)/,$(SRC:.cpp=.o))
+
+DEPEND_FILE=$(addprefix $(OBJDIR)/, $(SRC:.cpp=.d))
+TEST_FILE=$(addprefix $(TOPDIR)bin/, $(SRC:.cpp=$(OBJSUF).exe))
+
+.PHONY: test
+

data/vendor/cybozulib/common.props

@@ -0,0 +1,25 @@
+����<?xml version="1.0" encoding="utf-8"?>
+<Project ToolsVersion="4.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+  <ImportGroup Label="PropertySheets" />
+  <PropertyGroup Label="UserMacros" />
+  <PropertyGroup>
+    <OutDir>$(SolutionDir)bin\</OutDir>
+  </PropertyGroup>
+  <ItemDefinitionGroup>
+    <ClCompile>
+      <AdditionalIncludeDirectories>$(SolutionDir)include;$(SolutionDir)../cybozulib_ext/openssl/include;$(SolutionDir)../cybozulib_ext/zlib/include;$(SolutionDir)../cybozulib_ext/mecab/include;$(SolutionDir)../cybozulib_ext/eigen/</AdditionalIncludeDirectories>
+    </ClCompile>
+  </ItemDefinitionGroup>
+  <ItemDefinitionGroup>
+    <ClCompile>
+      <WarningLevel>Level4</WarningLevel>
+      <PrecompiledHeaderFile />
+      <PrecompiledHeaderOutputFile />
+      <PreprocessorDefinitions>_MBCS;%(PreprocessorDefinitions);NOMINMAX</PreprocessorDefinitions>
+    </ClCompile>
+    <Link>
+      <AdditionalLibraryDirectories>$(SolutionDir)../cybozulib_ext/zlib/lib;$(SolutionDir)../cybozulib_ext/openssl/lib</AdditionalLibraryDirectories>
+    </Link>
+  </ItemDefinitionGroup>
+  <ItemGroup />
+</Project>