enquo-core 0.5.0.2.g015cdff → 0.6.0.4.gd752e84

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3302999f4948aaf1bc91fdc95536c47a7f2037ff28db477262d5d85cac40c977
-  data.tar.gz: 5e764c01c2691d27276d88585be770bf424b16d60947fa8d63ae6e83636f830e
+  metadata.gz: 3dfc1b777651bc1aaccc983a226023962ebb3a566badff9c0c1cfd80c21c2ab6
+  data.tar.gz: f4d046426b428b0c6142ff581301b1e9137508bcef5d48850b983d60a58c91b3
 SHA512:
-  metadata.gz: 3e973ba1ae41f2a633dc14593a7e14f26f329d72145a0b1ac014621f768fdcf7d6fb89320fb14c5b1e08178e3450edc3981751bbcb50d037a2b13bf566f81db3
-  data.tar.gz: e0c0a4b078933d673d0a827dab519d24cfd4762501a24b11a4e723391aee6e5ada6e829b0339a990f1c50cc0be0cf69e89693799085d7193c9a1baa05b59bf53
+  metadata.gz: 9e93651c57ae0bf2f1c141c4fbabadd34ba51bde2c8da481ec077a352d19184b151459202fd521654a8534cd959cbbe9d7e44ffbffa09f775fb51e131d830553
+  data.tar.gz: 2b131ac4df53533d2433b59d621efe92ed04116c6d4b1b3236aba62419fddcf5bf803c9a8b66011db9ac3269b2348b5e554d2cdd7fa2063fa22b254e9cab44ef

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.5.0.2.g015cdff
+  version: 0.6.0.4.gd752e84
 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: