enquo-core 0.6.0 → 0.6.0.5.g36d0d51

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bcf12f9a2c0fe653f6b34e5e7ab9914d105e924d35ccc8470b25d65c74f564b6
-  data.tar.gz: d31beface873561e3b2ef47508c3e39e67c25ff2f1e4e69b5c2bda220b9af164
+  metadata.gz: e73700af39b475e892dcea44505b58a38ecd9a267a68d63f150efbf7d11ec0f1
+  data.tar.gz: d4e4a76663c9dddd6ab197f1a1d7d86bf5bbec57b738515a76c16695735b8d73
 SHA512:
-  metadata.gz: 9dab51ccec229e7e60003648fcb2ac28bca3af5e0772c02ad410f5e39037c84546b41857605467cda0bd9b2455095f98a9b07456235936915fa1b74c9a85a40d
-  data.tar.gz: 9b3ee13bfe6ef04143c8b162b0beb0e390c18845ecbb2fd7b34ee7fc2fca92bdbc6fbd9320e021945d27b7fe8ed8f58edf97dfaf13e9cf8f169b61b293a688ce
+  metadata.gz: 0d320cbc124da02a272d225b99fb2fa9cf7ca892de472a4abc673f055a489bcb3498b36f66fac8ba17d4d500171cf17fd9affece79c3d342b908241170fcdba3
+  data.tar.gz: 8ff73c3ac535ac7a3af5222701ab39ab9f884740f7a845d563202d589a83b9d5919f810979245b3caa995d78e7c8f69e35c1d1a6d8adf3ffabb321c30f0f7239

data/README.md

@@ -0,0 +1,55 @@
+This directory contains the Ruby bindings for the [Enquo](https://enquo.org) core cryptography library.
+
+## Note Well
+
+When reading these docs, bear in mind that this is a *low level* cryptographic library.
+It is not intended that most users will use `enquo-core` directly.
+Instead, typically you will use Enquo via your preferred ORM or other higher-level integration.
+This library is intended to be used to build *those* integrations, not to be used in applications directly.
+
+
+# Installation
+
+Typically you'll want to install [the rubygem]:
+
+```bash
+gem install enquo-core
+```
+
+If you use a platform for which pre-built binary packages are available, this will Just Work.
+Otherwise, you'll need a [Rust toolchain](https://www.rust-lang.org/learn/get-started) to build.
+
+
+# Usage
+
+The Enquo core is all about encrypting and decrypting *field data*, using keys derived from a *root*.
+
+Load the library:
+
+```ruby
+require "enquo-core"
+```
+
+Create the root key, from which all other cryptographic keys are derived:
+
+```ruby
+root_key = Enquo::RootKey::Static.new(SecureRandom.bytes(32))
+```
+
+(In real-world use, you'll want to take that key from somewhere it can be securely stored)
+
+Now, you can create the root itself:
+
+```ruby
+root = Enquo::Root.new(root_key)
+```
+
+Finally, you can now create a "field" object, which is what is used to do encryption and decryption:
+
+```ruby
+f = root.field("some_relation", "some_field_name")
+ciphertext = f.encrypt_text("this is some text", "test")
+puts f.decrypt_text(ciphertext, "test").inspect  # Should print "this is some text"
+```
+
+For more details on the full API, consult [the fine manual](https://www.rubydoc.info/gems/enquo-core).

data/lib/enquo/root_key/static.rb

@@ -2,23 +2,23 @@ module Enquo
 	module RootKey
 		class Static
 			def self.new(k)
-            unless k.is_a?(String)
-               raise ArgumentError, "An Enquo static root key must be passed a string"
-            end
+				unless k.is_a?(String)
+					raise ArgumentError, "An Enquo static root key must be passed a string"
+				end
 
-            key = if k.encoding == Encoding::BINARY
-               unless k.bytesize == 32
-                  raise ArgumentError, "An Enquo static root key must be a 32 byte binary string"
-               end
+				key = if k.encoding == Encoding::BINARY
+					unless k.bytesize == 32
+						raise ArgumentError, "An Enquo static root key must be a 32 byte binary string"
+					end
 
-               k
-            else
-               unless k =~ /\A\h{64}\z/
-                  raise ArgumentError, "An Enquo static root key must be a 64 byte hex string"
-               end
+					k
+				else
+					unless k =~ /\A\h{64}\z/
+						raise ArgumentError, "An Enquo static root key must be a 64 byte hex string"
+					end
 
-               [k].pack("H*")
-            end
+					[k].pack("H*")
+				end
 
 				_new(key)
 			end

data/lib/enquo-core.rb

@@ -0,0 +1 @@
+require_relative "./enquo.rb"

data/lib/enquo_core.rb

@@ -0,0 +1 @@
+require_relative "./enquo.rb"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: enquo-core
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.0.5.g36d0d51
 platform: ruby
 authors:
 - Matt Palmer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-07 00:00:00.000000000 Z
+date: 2023-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -158,17 +158,20 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- README.md
 - enquo-core.gemspec
 - ext/enquo/.gitignore
 - ext/enquo/Cargo.lock
 - ext/enquo/Cargo.toml
 - ext/enquo/extconf.rb
 - ext/enquo/src/lib.rs
+- lib/enquo-core.rb
 - lib/enquo.rb
 - lib/enquo/field.rb
 - lib/enquo/root.rb
 - lib/enquo/root_key.rb
 - lib/enquo/root_key/static.rb
+- lib/enquo_core.rb
 homepage: https://enquo.org/active_enquo
 licenses: []
 metadata:
@@ -187,9 +190,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: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.1.6
 signing_key: