enquo-core 0.6.0-x86_64-linux → 0.6.0.5.g36d0d51-x86_64-linux

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa6d930de0eefd203b355470d96ac72d5050eb1b349418192a274345e0f103c2
-  data.tar.gz: d61896d3955bd7a82b8ef3628e5afa8a502f7ec67e861f1c5e2a44fd3f81da5e
+  metadata.gz: c12f31f24b2bf6982235e17e31e249771ff140c24d8e775882592a460ebf3492
+  data.tar.gz: e9bdde54b57fb268d925190858e2f13d4f58460447c3a9f417f168531e8aee48
 SHA512:
-  metadata.gz: 21803bc37369fbe7aab701c671df468607a6456f8663caa3075bb2b4c99833a6166ac53c4d9e1fd9a9ecb64e5cdf2a265ffb8de19ceeea72e8617ef31070c7fa
-  data.tar.gz: 9a1faa00d1cce3962e6dbfefdd7ff6b386a1e68554382dc83707b56d855e40bf2e591d6b58125c030c4607b00193fb535b851e7d42bab2fb7ecff45c629db599
+  metadata.gz: 4afc87a142593a3883deb7de8c269cb0d94a22880152fa2feaf22694a158ed17c82b3d63e9f228a9a7eb402e1c805cc45504db6fdf9ada1bcb8069e4aa609639
+  data.tar.gz: 383207a7034c0251172a9301f6118b32c979e154b465c54d1c18c2150ccc520f08eebd46a21b8275845b5e4cf461e4a2487327bc06ce4e320be490a6533ce588

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: x86_64-linux
 authors:
 - Matt Palmer
-autorequire:
+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
@@ -150,7 +150,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
+description: 
 email:
 - matt@enquo.org
 executables: []
@@ -158,6 +158,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- README.md
 - enquo-core.gemspec
 - ext/enquo/.gitignore
 - ext/enquo/Cargo.lock
@@ -167,11 +168,13 @@ files:
 - lib/2.7/enquo.so
 - lib/3.0/enquo.so
 - lib/3.1/enquo.so
+- 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:
@@ -179,7 +182,7 @@ metadata:
   source_code_uri: https://github.com/enquo/enquo-core
   changelog_uri: https://github.com/enquo/enquo-core/releases
   bug_tracker_uri: https://github.com/enquo/enquo-core/issues
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -193,12 +196,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 3.2.dev
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.3.22
-signing_key:
+rubygems_version: 3.4.3
+signing_key: 
 specification_version: 4
 summary: Core library for encrypted querying operations
 test_files: []