tanker-core 2.6.1 → 2.6.2.alpha.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0162ad3260fee46586e016ed0f25362012314ec16ddd6ee16de7cef809605781
-  data.tar.gz: 46786313d49bead7e77739ccff41e3ce73c5e4512bcb7e86debc025fedb305c9
+  metadata.gz: 4030af33c99899c480fc62286362e26893bd25b4fa96f41050b40048c7acce81
+  data.tar.gz: d15b32bc587200da57320bbc455f70edc6b7982b3062c68b98dc0aedf5f310d4
 SHA512:
-  metadata.gz: c8185aff0d708105ce6c89ed04641a22bdca4504349cc15f5ebb54a31cfd102a73313dc02ce4f98ff2d6800cd22f6c1047e9955335b915e63d99aebdaed8c25b
-  data.tar.gz: 6418bee3000a46173b8b6f1e0cb1954e03a92ea65b519ab4e0f993aadad320617e589ca195cd8dbf3253331251d4302978ebdb52dfb76fc5af7881298fe27548
+  metadata.gz: b387a24c5fe2fd478b49063eb96db6c8458aee6484604a3b50c928cee5d9ea05a70f7f57268da12eacd6dd01440490b9bc2eb3f06443462ce979c43cb8124769
+  data.tar.gz: 8c630b486af54f393a0a146a538a008fc38402a48dafc38795159499f5e413495abc38e0b1f37e428b9569ce77f8a7e27cbf0540130e8f641fb22c61406bdae7

data/lib/tanker/c_tanker/c_lib.rb

@@ -1,15 +1,10 @@
 # frozen_string_literal: true
 
+require 'ffi/platform'
+
 module Tanker::CTanker
   def self.get_path(name)
-    if /darwin/ =~ RUBY_PLATFORM
-      ext = '.dylib'
-      subdir = 'mac64'
-    else
-      ext = '.so'
-      subdir = 'linux64'
-    end
-
-    File.expand_path "../../../vendor/libctanker/#{subdir}/tanker/lib/lib#{name}#{ext}", __dir__
+    File.expand_path "../../../vendor/tanker/#{FFI::Platform::OS}-#{FFI::Platform::ARCH}/"\
+      "#{FFI::Platform::LIBPREFIX}#{name}.#{FFI::Platform::LIBSUFFIX}", __dir__
   end
 end

data/lib/tanker/core/stream.rb

@@ -3,6 +3,29 @@
 require 'English'
 require 'tanker/c_tanker'
 
+# Because Ruby only has synchronous streams, we can't read them on Tanker's
+# thread (in the read callback). To work around that, we start a new Thread for
+# each read operation. This is not that bad because Ruby uses a thread pool
+# behind the scenes and creating a Thread is usually just a work pushed on a
+# queue.
+#
+# Also, there doesn't seem to easily create an IO object. The simplest way is to
+# create a pipe. A pipe is a stream where you read everything you write into it.
+# Tanker streams however are pull streams, so there must be something that pulls
+# from the Tanker stream and pushes onto the IO stream. We start a long-running
+# thread for that which just loops.
+#
+# Because so much is happening in parallel, synchronization is not trivial.
+# There's one mutex per stream, and we lock that same mutex for every critical
+# section. Here are some important constraints that must be held:
+# - Do not copy data to the Tanker buffer if tanker_stream_close has been
+# called
+# - Do not call tanker_stream_read_operation_finish if tanker_stream_close has
+# been called
+# - On the output stream, do not call tanker_stream_read on a closed/closing
+# stream. Though it is ok to close the stream after the call, but before the
+# future is resolved.
+
 module Tanker
   class Core
     def encrypt_stream(stream, encryption_options = nil)
@@ -95,21 +118,6 @@ module Tanker
     end
   end
 
-  # IMPORTANT: about synchronization
-  # Because of a design flaw in the Tanker C streaming API, it is difficult to
-  # handle cancelation. When canceling a read (closing the stream), Tanker
-  # doesn't forward the cancelation request to the input stream (there's no
-  # callback for that), which means that the callback maybe writing to a buffer
-  # that's being freed. We worked around that by adding a mutex and locking it
-  # in both the output stream and the input stream.
-  # Things to be careful about:
-  # - Do not copy data to the Tanker buffer if tanker_stream_close has been
-  # called
-  # - Do not call tanker_stream_read_operation_finish if tanker_stream_close has
-  # been called
-  # - On the output stream, do not call tanker_stream_read on a closed/closing
-  # stream. Though it is ok to close the stream after the call, but before the
-  # future is resolved.
   class IoToTankerStreamWrapper
     attr_reader :error
     attr_reader :read_method

data/lib/tanker/core/version.rb

@@ -2,7 +2,7 @@
 
 module Tanker
   class Core
-    VERSION = '2.6.1'
+    VERSION = '2.6.2.alpha.6'
 
     def self.native_version
       CTanker.tanker_version_string

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tanker-core
 version: !ruby/object:Gem::Version
-  version: 2.6.1
+  version: 2.6.2.alpha.6
 platform: ruby
 authors:
 - Tanker team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-22 00:00:00.000000000 Z
+date: 2020-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -165,8 +165,7 @@ files:
 - lib/tanker/encryption_options.rb
 - lib/tanker/error.rb
 - lib/tanker/sharing_options.rb
-- vendor/libctanker/linux64/tanker/lib/libctanker.so
-- vendor/libctanker/mac64/tanker/lib/libctanker.dylib
+- vendor/tanker/linux-x86_64/libctanker.so
 homepage: https://tanker.io
 licenses:
 - Apache-2.0
@@ -184,9 +183,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.0.3
 signing_key: