Sandbox zopfli

contrib/README.md

@@ -9,6 +9,7 @@ Directory   | Project                                           | Home Page
 ----------- | ------------------------------------------------- | -------------------------------------------------------------------- | -----------
 `jsonnet/`  | Jsonnet - The Data Templating Language            | [github.com/google/jsonnet](https://github.com/google/jsonnet)       | CMake
 `hunspell/` | Hunspell - The most popular spellchecking library | [github.com/hunspell/hunspell](https://github.com/hunspell/hunspell) | CMake
+`zopfli`    | Zopfli - Compression Algorithm                    | [github.com/google/zopfli](https://github.com/google/zopfli)         | CMake
 `zstd/`     | Zstandard - Fast real-time compression algorithm  | [github.com/facebook/zstd](https://github.com/facebook/zstd)         | CMake
 
 ## Projects Shipping with Sandboxed API Sandboxes

contrib/zopfli/CMakeLists.txt

@@ -0,0 +1,73 @@
+# Copyright 2022 Google LLC
+#
+# 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
+#
+#     https://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.
+
+cmake_minimum_required(VERSION 3.13)
+
+project(sapi_zopfli CXX)
+
+set(CMAKE_CXX_STANDARD 17)
+set(CMAKE_CXX_STANDARD_REQUIRED True)
+
+if(NOT TARGET sapi::sapi)
+  set(SAPI_ROOT "../.." CACHE PATH "Path to the Sandboxed API source tree")
+
+  add_subdirectory(
+    "${SAPI_ROOT}"
+    "${CMAKE_BINARY_DIR}/sandboxed-api-build"
+    EXCLUDE_FROM_ALL
+  )
+endif()
+
+FetchContent_Declare(
+  libzopfli
+
+  GIT_REPOSITORY https://github.com/google/zopfli.git
+  GIT_TAG 831773bc28e318b91a3255fa12c9fcde1606058b
+)
+FetchContent_MakeAvailable(libzopfli)
+
+add_sapi_library(
+  sapi_zopfli
+
+  FUNCTIONS
+    ZopfliInitOptions
+
+    ZopfliCompress
+
+    ZopfliDeflate
+    ZopfliZlibCompress
+    ZopfliGzipCompress
+
+  INPUTS
+    ${libzopfli_SOURCE_DIR}/src/zopfli/deflate.h
+    ${libzopfli_SOURCE_DIR}/src/zopfli/zlib_container.h
+    ${libzopfli_SOURCE_DIR}/src/zopfli/gzip_container.h
+
+  LIBRARY libzopfli
+  LIBRARY_NAME Zopfli
+  NAMESPACE ""
+)
+add_library(sapi_contrib::zopfli ALIAS sapi_zopfli)
+
+target_include_directories(sapi_zopfli INTERFACE
+  "${PROJECT_BINARY_DIR}"
+)
+
+if(SAPI_ENABLE_EXAMPLES)
+  add_subdirectory(example)
+endif()
+
+if(SAPI_ENABLE_TESTS)
+  add_subdirectory(test)
+endif()

contrib/zopfli/example/CMakeLists.txt

@@ -0,0 +1,28 @@
+# Copyright 2022 Google LLC
+#
+# 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
+#
+#     https://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.
+
+add_executable(
+  sapi_minizopfli
+
+  main.cc
+  ../utils/utils_zopfli.cc
+)
+
+target_link_libraries(
+  sapi_minizopfli PRIVATE
+
+  sapi_zopfli
+  sapi::sapi
+  absl::flags_parse
+)

contrib/zopfli/example/main.cc

@@ -0,0 +1,73 @@
+// Copyright 2022 Google LLC
+//
+// 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
+//
+//     https://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.
+
+#include <unistd.h>
+
+#include <fstream>
+#include <iostream>
+#include <string>
+
+#include "absl/flags/flag.h"
+#include "absl/flags/parse.h"
+#include "contrib/zopfli/sandboxed.h"
+#include "contrib/zopfli/utils/utils_zopfli.h"
+
+ABSL_FLAG(bool, zlib, false, "zlib compression");
+ABSL_FLAG(bool, gzip, false, "gzip compression");
+
+int main(int argc, char* argv[]) {
+  std::string prog_name(argv[0]);
+  google::InitGoogleLogging(argv[0]);
+  std::vector<char*> args = absl::ParseCommandLine(argc, argv);
+
+  if (args.size() != 3) {
+    std::cerr << "Usage:\n  " << prog_name << " INPUT OUTPUT\n";
+    return EXIT_FAILURE;
+  }
+
+  std::ifstream infile(args[1], std::ios::binary);
+  if (!infile.is_open()) {
+    std::cerr << "Unable to open " << args[1] << std::endl;
+    return EXIT_FAILURE;
+  }
+  std::ofstream outfile(args[2], std::ios::binary);
+  if (!outfile.is_open()) {
+    std::cerr << "Unable to open " << args[2] << std::endl;
+    return EXIT_FAILURE;
+  }
+
+  ZopfliSapiSandbox sandbox;
+  if (!sandbox.Init().ok()) {
+    std::cerr << "Unable to start sandbox\n";
+    return EXIT_FAILURE;
+  }
+
+  ZopfliApi api(&sandbox);
+
+  ZopfliFormat format = ZOPFLI_FORMAT_DEFLATE;
+  if (absl::GetFlag(FLAGS_zlib)) {
+    format = ZOPFLI_FORMAT_ZLIB;
+  } else if (absl::GetFlag(FLAGS_gzip)) {
+    format = ZOPFLI_FORMAT_GZIP;
+  }
+
+  absl::Status status = Compress(api, infile, outfile, format);
+  if (!status.ok()) {
+    std::cerr << "Unable to compress file.\n";
+    std::cerr << status << std::endl;
+    return EXIT_FAILURE;
+  }
+
+  return EXIT_SUCCESS;
+}

contrib/zopfli/sandboxed.h

@@ -0,0 +1,42 @@
+// Copyright 2022 Google LLC
+//
+// 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
+//
+//     https://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.
+
+#ifndef CONTRIB_ZOPFLI_SANDBOXED_
+#define CONTRIB_ZOPFLI_SANDBOXED_
+
+#include <memory>
+
+#include <libgen.h>
+#include <syscall.h>
+
+#include "sapi_zopfli.sapi.h"
+
+class ZopfliSapiSandbox : public ZopfliSandbox {
+ public:
+  std::unique_ptr<sandbox2::Policy> ModifyPolicy(
+      sandbox2::PolicyBuilder *) override {
+    return sandbox2::PolicyBuilder()
+        .AllowStaticStartup()
+        .AllowWrite()
+        .AllowExit()
+        .AllowMmap()
+        .AllowSystemMalloc()
+        .AllowSyscalls({
+            __NR_sysinfo,
+        })
+        .BuildOrDie();
+  }
+};
+
+#endif  // CONTRIB_ZOPFLI_SANDBOXED_

contrib/zopfli/test/CMakeLists.txt

@@ -0,0 +1,33 @@
+# Copyright 2022 Google LLC
+#
+# 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
+#
+#     https://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.
+
+include(GoogleTest)
+
+add_executable(
+  sapi_zopfli_test
+
+  zopfli_test.cc
+  ../utils/utils_zopfli.cc
+)
+
+
+target_link_libraries(
+  sapi_zopfli_test PRIVATE
+
+  sapi_zopfli
+  sapi::temp_file
+  sapi::test_main
+)
+
+gtest_discover_tests(sapi_zopfli_test PROPERTIES ENVIRONMENT "TEST_FILES_DIR=${PROJECT_SOURCE_DIR}/files")

contrib/zopfli/test/zopfli_test.cc

@@ -0,0 +1,98 @@
+// Copyright 2022 Google LLC
+//
+// 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
+//
+//     https://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.
+
+#include <fstream>
+
+#include "../sandboxed.h"
+#include "../utils/utils_zopfli.h"
+#include "sandboxed_api/util/path.h"
+#include "sandboxed_api/util/status_matchers.h"
+#include "sandboxed_api/util/temp_file.h"
+
+namespace {
+
+using ::sapi::IsOk;
+using ::testing::IsEmpty;
+using ::testing::Not;
+
+std::string GetTestFilePath(const std::string& filename) {
+  return sapi::file::JoinPath(getenv("TEST_FILES_DIR"), filename);
+}
+
+std::string GetTemporaryFile(const std::string& filename) {
+  absl::StatusOr<std::string> tmp_file =
+      sapi::CreateNamedTempFileAndClose(filename);
+  if (!tmp_file.ok()) {
+    return "";
+  }
+
+  return sapi::file::JoinPath(sapi::file_util::fileops::GetCWD(), *tmp_file);
+}
+
+class TestText : public testing::TestWithParam<ZopfliFormat> {};
+
+class TestBinary : public testing::TestWithParam<ZopfliFormat> {};
+
+TEST_P(TestText, Compress) {
+  ZopfliSapiSandbox sandbox;
+  ASSERT_THAT(sandbox.Init(), IsOk()) << "Couldn't initialize Sandboxed API";
+  ZopfliApi api = ZopfliApi(&sandbox);
+
+  std::string infile_s = GetTestFilePath("text");
+  std::string outfile_s = GetTemporaryFile("text.out");
+  ASSERT_THAT(outfile_s, Not(IsEmpty()));
+
+  std::ifstream infile(infile_s, std::ios::binary);
+  ASSERT_TRUE(infile.is_open());
+
+  std::ofstream outfile(outfile_s, std::ios::binary);
+  ASSERT_TRUE(outfile.is_open());
+
+  absl::Status status = Compress(api, infile, outfile, GetParam());
+  ASSERT_THAT(status, IsOk()) << "Unable to compress file";
+
+  ASSERT_LT(outfile.tellp(), infile.tellg());
+}
+
+INSTANTIATE_TEST_SUITE_P(SandboxTest, TestText,
+                         testing::Values(ZOPFLI_FORMAT_DEFLATE,
+                                         ZOPFLI_FORMAT_GZIP,
+                                         ZOPFLI_FORMAT_ZLIB));
+
+TEST_P(TestBinary, Compress) {
+  ZopfliSapiSandbox sandbox;
+  ASSERT_THAT(sandbox.Init(), IsOk()) << "Couldn't initialize Sandboxed API";
+  ZopfliApi api = ZopfliApi(&sandbox);
+
+  std::string infile_s = GetTestFilePath("binary");
+  std::string outfile_s = GetTemporaryFile("binary.out");
+  ASSERT_THAT(outfile_s, Not(IsEmpty()));
+
+  std::ifstream infile(infile_s, std::ios::binary);
+  ASSERT_TRUE(infile.is_open());
+
+  std::ofstream outfile(outfile_s, std::ios::binary);
+  ASSERT_TRUE(outfile.is_open());
+
+  absl::Status status = Compress(api, infile, outfile, GetParam());
+  ASSERT_THAT(status, IsOk()) << "Unable to compress file";
+
+  ASSERT_LT(outfile.tellp(), infile.tellg());
+}
+
+INSTANTIATE_TEST_SUITE_P(SandboxTest, TestBinary,
+                         testing::Values(ZOPFLI_FORMAT_DEFLATE,
+                                         ZOPFLI_FORMAT_GZIP,
+                                         ZOPFLI_FORMAT_ZLIB));
+}  // namespace

contrib/zopfli/utils/utils_zopfli.cc

@@ -0,0 +1,56 @@
+// Copyright 2022 Google LLC
+//
+// 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
+//
+//     https://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.
+
+#include <unistd.h>
+
+#include <fstream>
+
+#include "../sandboxed.h"
+
+absl::Status Compress(ZopfliApi& api, std::ifstream& instream,
+                      std::ofstream& outstream, ZopfliFormat format) {
+  // Get size of Stream
+  instream.seekg(0, std::ios_base::end);
+  std::streamsize ssize = instream.tellg();
+  instream.seekg(0, std::ios_base::beg);
+
+  // Read data
+  sapi::v::Array<uint8_t> inbuf(ssize);
+  instream.read(reinterpret_cast<char*>(inbuf.GetData()), ssize);
+  if (instream.gcount() != ssize) {
+    return absl::UnavailableError("Unable to read file");
+  }
+
+  // Compress
+  sapi::v::Struct<ZopfliOptions> options;
+  SAPI_RETURN_IF_ERROR(api.ZopfliInitOptions(options.PtrAfter()));
+
+  sapi::v::GenericPtr outptr;
+  sapi::v::IntBase<size_t> outsize(0);
+
+  SAPI_RETURN_IF_ERROR(
+      api.ZopfliCompress(options.PtrBefore(), format, inbuf.PtrBefore(), ssize,
+                         outptr.PtrAfter(), outsize.PtrBoth()));
+
+  // Get and save data
+  sapi::v::Array<int8_t> outbuf(outsize.GetValue());
+  outbuf.SetRemote(reinterpret_cast<void*>(outptr.GetValue()));
+  SAPI_RETURN_IF_ERROR(api.GetSandbox()->TransferFromSandboxee(&outbuf));
+
+  outstream.write(reinterpret_cast<char*>(outbuf.GetData()), outbuf.GetSize());
+  if (!outstream.good()) {
+    return absl::UnavailableError("Unable to write file");
+  }
+  return absl::OkStatus();
+}

contrib/zopfli/utils/utils_zopfli.h

@@ -0,0 +1,21 @@
+// Copyright 2022 Google LLC
+//
+// 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
+//
+//     https://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.
+
+#ifndef CONTRIB_ZOPFLI_UTILS_UTILS_ZOPFLI_H_
+#define CONTRIB_ZOPFLI_UTILS_UTILS_ZOPFLI_H_
+
+absl::Status Compress(ZopfliApi& api, std::ifstream& instream,
+                      std::ofstream& outstream, ZopfliFormat format);
+
+#endif  // CONTRIB_ZOPFLI_UTILS_UTILS_ZOPFLI_H_