enveloperb 0.0.0.1.ENOTAG → 0.1.0

data/README.md

@@ -19,22 +19,24 @@ Except for testing purposes, it is not common to use envelope encryption in situ
 
 # Installation
 
-For the most common platforms, we provide "native" gems (which have the shared object that provides the cryptographic primitives pre-compiled).
-At present, we provide native gems for:
+In order to build the `enveloperb` gem, you must have Rust 1.31.0 or later installed.
+On an ARM-based platform, you must use Rust nightly, for SIMD intrinsics support.
 
-* Linux `x86_64` and `aarch64`
-* macOS `x86_64` and `arm64`
+With that available, you should be able to install it like any other gem:
 
-On these platforms, you can just install the `enveloperb` gem via your preferred method, and it should "just work".
-If it doesn't, please [report that as a bug](https://github.com/cipherstash/enveloperb/issues).
+    gem install enveloperb
 
-For other platforms, you will need to install the source gem, which requires that you have Rust 1.57.0 or later installed.
-On ARM-based platforms, you must use Rust nightly, for SIMD intrinsics support.
+There's also the wonders of [the Gemfile](http://bundler.io):
 
-## Installing from Git
+    gem 'enveloperb'
 
-If you have a burning need to install directly from a checkout of the git repository, you can do so by running `bundle install && rake install`.
-As this is a source-based installation, you will need to have Rust installed, as described above.
+If you're the sturdy type that likes to run from git:
+
+    bundle install
+    rake install
+
+Or, if you've eschewed the convenience of Rubygems entirely, then you
+presumably know what to do already.
 
 
 # Usage

data/enveloperb.gemspec

@@ -7,7 +7,7 @@ end
 Gem::Specification.new do |s|
   s.name = "enveloperb"
 
-  s.version = ENV.fetch("GVB_VERSION_OVERRIDE") { GVB.version rescue "0.0.0.1.NOGVB" }
+  s.version = GVB.version rescue "0.0.0.1.NOGVB"
   s.date    = GVB.date    rescue Time.now.strftime("%Y-%m-%d")
 
   s.platform = Gem::Platform::RUBY
@@ -20,18 +20,19 @@ Gem::Specification.new do |s|
 
   s.files = `git ls-files -z`.split("\0").reject { |f| f =~ /^(\.|G|spec|Rakefile)/ }
 
-  s.extensions = ["ext/enveloperb/extconf.rb"]
+  s.extensions = ["ext/Rakefile"]
+  s.require_paths = ["lib", "target"]
 
   s.required_ruby_version = ">= 2.7.0"
 
+  s.add_runtime_dependency "rutie", "~> 0.0.4"
+
   s.add_development_dependency 'bundler'
+  s.add_development_dependency 'gem-compiler'
   s.add_development_dependency 'github-release'
   s.add_development_dependency 'guard-rspec'
-  s.add_development_dependency 'rake', '~> 13.0'
-  s.add_development_dependency 'rake-compiler', '~> 1.2'
-  s.add_development_dependency 'rake-compiler-dock', '~> 1.2'
+  s.add_development_dependency 'rake', '~> 10.4', '>= 10.4.2'
   s.add_development_dependency 'rb-inotify', '~> 0.9'
-  s.add_development_dependency 'rb_sys', '~> 0.1'
   s.add_development_dependency 'redcarpet'
   s.add_development_dependency 'rspec'
   s.add_development_dependency 'simplecov'

data/ext/Rakefile

@@ -0,0 +1,5 @@
+task :build do
+  sh "cargo build --release"
+end
+
+task default: :build

data/lib/enveloperb.rb

@@ -1,15 +1,7 @@
-module Enveloperb
-end
+require "rutie"
 
-begin
-  RUBY_VERSION =~ /(\d+\.\d+)/
-  require_relative "./#{$1}/enveloperb"
-rescue LoadError
-  begin
-    require_relative "./enveloperb.#{RbConfig::CONFIG["DLEXT"]}"
-  rescue LoadError
-    raise LoadError, "Failed to load enveloperb.#{RbConfig::CONFIG["DLEXT"]}; either it hasn't been built, or was built incorrectly for your system"
-  end
+module Enveloperb
+  Rutie.new(:enveloperb).init 'Init_enveloperb', __dir__
 end
 
 require_relative "./enveloperb/encrypted_record"

data/{ext/enveloperb/src → src}/lib.rs

@@ -10,7 +10,7 @@ extern crate lazy_static;
 use aws_config;
 use aws_sdk_kms;
 use aws_types;
-use envelopers::{EncryptedRecord, EnvelopeCipher, KMSKeyProvider, SimpleKeyProvider};
+use enveloper::{EncryptedRecord, EnvelopeCipher, KMSKeyProvider, SimpleKeyProvider};
 use std::borrow::Cow;
 use tokio::runtime::Runtime;
 use rutie::{Class, Encoding, Hash, Module, Object, RString, Symbol, VerifiedObject, VM};

metadata

@@ -1,31 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: enveloperb
 version: !ruby/object:Gem::Version
-  version: 0.0.0.1.ENOTAG
+  version: 0.1.0
 platform: ruby
 authors:
 - Matt Palmer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-18 00:00:00.000000000 Z
+date: 2022-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rutie
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: 0.0.4
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.4
 - !ruby/object:Gem::Dependency
-  name: github-release
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: guard-rspec
+  name: gem-compiler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,47 +53,53 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: github-release
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake-compiler
+  name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake-compiler-dock
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '10.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.4.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '10.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.4.2
 - !ruby/object:Gem::Dependency
   name: rb-inotify
   requirement: !ruby/object:Gem::Requirement
@@ -108,20 +114,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-- !ruby/object:Gem::Dependency
-  name: rb_sys
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
@@ -183,23 +175,21 @@ email:
 - matt@cipherstash.com
 executables: []
 extensions:
-- ext/enveloperb/extconf.rb
+- ext/Rakefile
 extra_rdoc_files: []
 files:
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
-- LICENSE
+- Cargo.toml
+- LICENCE
 - README.md
 - enveloperb.gemspec
-- ext/enveloperb/.gitignore
-- ext/enveloperb/Cargo.lock
-- ext/enveloperb/Cargo.toml
-- ext/enveloperb/extconf.rb
-- ext/enveloperb/src/lib.rs
+- ext/Rakefile
 - lib/enveloperb.rb
 - lib/enveloperb/awskms.rb
 - lib/enveloperb/encrypted_record.rb
 - lib/enveloperb/simple.rb
+- src/lib.rs
 homepage: https://github.com/cipherstash/enveloperb
 licenses: []
 metadata: {}
@@ -207,6 +197,7 @@ post_install_message:
 rdoc_options: []
 require_paths:
 - lib
+- target
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -214,9 +205,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.1.6
 signing_key: 

data/LICENSE

@@ -1,124 +0,0 @@
-CipherStash Client Library Licence Agreement
-
-0. Background
-
-This licence sets out the terms on which you are permitted to use client side
-components of software provided by CipherStash to query encrypted databases
-(CipherStash Client Software).The operation of the CipherStash Client Software
-is dependent on encryption keys generated by server software operated or
-licensed by CipherStash.
-
-1. Definitions
-
-1.1 In these terms the following terms have the following meanings:
-    (a) Authorised Purpose in relation to the CipherStash Source Code has the
-        meaning given to it in clause 2.4;
-    (b) CipherStash Source Code means human readable code of the CipherStash
-        Client Software;
-    (c) CipherStash Executable means the machine executable code of the
-        CipherStash Client Software as made available by CipherStash from
-        time to time;
-    (d) CipherStash Client Software has the meaning given to it in the
-        Background;
-    (e) Licensed Query means a query on a database that:
-        (i)  uses an encryption key generated by a key server operated or
-             licensed by CipherStash for all encryption of the content of that
-             query or of results returned in response to that query (excluding
-             encryption in the transport layer for communications between
-             servers); and
-        (ii) uses a valid token provided by CipherStash in the course of
-             acquiring the key referred to in the previous paragraph;
-    (f) Your Applications means applications that you create that rely on any
-        part of the CipherStash Client Software in the course of their
-        operation.
-1.2 In these terms, unless the context requires otherwise, references to:
-    (a) encryption includes decryption;
-    (b) keys are references to data used for encryption, not data indicating a
-        row in a database table.
-
-2. Grant of Licence
-
-2.1 This licence permits you to do the following in relation to the CipherStash
-    Client Software:
-    (a) use the CipherStash Executables in the course of developing and testing
-        Your Applications;
-    (b) deploy and use copies of the CipherStash Executables for the purpose of
-        executing Licensed Queries, including as part of one or more of Your
-        Applications; and
-    (c) use the CipherStash Source Code solely for an Authorised Purpose.
-2.2 Subject to clause 2.4(c), you must not make any modifications to the
-    CipherStash Client Software.
-2.3 This licence specifically excludes any use of any part of the CipherStash
-    Client Software to execute any queries other than Licensed Queries on any
-    database.
-2.4 CipherStash makes the CipherStash Source Code available for the sole purpose
-    of allowing third parties to verify the operation, integrity and security
-    of the CipherStash Client Software (Authorised Purpose). This licence
-    permits you to do the following solely for an Authorised Purpose:
-    (a) download and review the CipherStash Source Code;
-    (b) build executable versions of the CipherStash Source Code to verify
-        correspondence between it and its associated CipherStash Executable;
-    (c) make configuration changes to the CipherStash Source Code solely to the
-        extent necessary to build a working executable version under paragraph
-        (b).
-
-3. Warranties and Liability
-
-3.1 To the extent permitted by law, CipherStash excludes all warranties,
-    guarantees and conditions that would otherwise be implied into this
-    agreement by law. Where CipherStash is not able to exclude such a warranty,
-    guarantee or condition, CipherStash limits, to the extent permitted by law,
-    its liability for a breach of that warranty, guarantee or condition to one
-    or more of the following at its option:
-    (a) in the case of goods, any one or more of the following:
-        (i)   the replacement of the goods or the supply of equivalent goods;
-        (ii)  the repair of the goods;
-        (iii) the payment of the cost of replacing the goods or of acquiring
-              equivalent goods;
-        (iv)  the payment of the cost of having the goods repaired; and
-    (b) in the case of services:
-        (i) the supplying of the services again; or
-        (ii) the payment of the cost of having the services supplied again.
-3.2 CipherStash has no liability to any person arising under or in relation to
-    this agreement (whether in tort, contract, equity or otherwise) for any
-    loss in the nature of consequential or economic loss. In particular,
-    CipherStash has no liability to any person for any: lost profits; loss of
-    savings, income or revenue; revenue not meeting targets or certain levels;
-    uptime or availability of internet connectivity or of the ability of third
-    parties to access a website, loss of opportunity; or loss of or corruption
-    of data. The exclusions in this clause 3.2 apply even in respect of loss or
-    damage that was foreseeable or about which either or both of the parties
-    were aware was likely to arise.
-
-4. Dispute Resolution
-
-4.1 Prior to commencing any action in any court or any action in any other form
-    of judicial or quasi-judicial forum you must comply with the requirements
-    of this clause 4.
-4.2 Where you believe there is a dispute between you and CipherStash in respect
-    of a matter the subject of this agreement you must notify CipherStash in
-    writing of the nature of that dispute and for a period of 120 days
-    following CipherStash’s receipt of that notification, make reasonable
-    attempts to resolve that dispute with CipherStash.
-
-5. General and Interpretation
-
-5.1 Except where expressly set out to the contrary, nothing in this agreement
-    grants the Customer any rights over any intellectual property rights
-    (including copyright, patents, and rights to the registration of such
-    rights) held by CipherStash at any time.
-5.2 No provision of this agreement may be construed against a party because
-    that party drafted that term.
-5.3 A waiver of rights under this agreement can only occur in writing signed by
-    the party granting the waiver. Except to the extent set out in the waiver,
-    a waiver is only effective in relation to the specific facts and rights set
-    out in it and does not operate to waive any other rights or to waive the
-    same rights in respect of different facts or circumstances.
-5.4 Where a part of this agreement is held by a court to be illegal or
-    otherwise unenforceable, and the unenforceability of that part does not
-    substantially alter the character of the bargain that would have been in
-    existence between the parties had that part been enforceable, that part is
-    severed and the balance of this agreement will continue unaffected.
-5.5 This contract is governed by the laws in force in the State of New South
-    Wales, Australia. Each party submits to the non-exclusive jurisdiction of
-    the courts of that State.

data/ext/enveloperb/.gitignore

@@ -1,4 +0,0 @@
-/target
-# Cargo.lock is deliberately *not* ignored; despite *technically* being a
-# library package, it is not a Rust library that is built into other projects,
-# but rather a standalone binary object that should be built reproducibly.