master-crypt 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ddc51b2b9cee74b590878d2093ba349bccf6d8f1e6bef36a0ada98ad6977b3cd
-  data.tar.gz: a72f8b1d23b86770904935f7d6de6acc668ad6666939411b155fdba18c6eb593
+  metadata.gz: d66fc7a3d34de5271f109f302daad32070724869cece105c062a844ae3bcc405
+  data.tar.gz: '06158f18251f6157085123568ee9818e46fea1e1f4dbf2db89f1f8293b7b7d6e'
 SHA512:
-  metadata.gz: 7ec2566a3bf3df9d14b6c9793a09445684fce23996fda681491ecf5755dc774e8f3d950aa8112385c4146c04fe6b5167b769a623e15de8933e65d0ad0e176406
-  data.tar.gz: 9ad6d7a3d566d109fcab5467c79b985a4a323bdf80253dfbab93e5e849ca7acdbd57c30cc4dbb0cd99725eebe1737798a4e2ea31799516a2072d4929d3520ff5
+  metadata.gz: da0d0b57b077b38d0e478d6940cf5c9de72b376cb8e9efbdccd0afefc04fabc1348fdf08ea014521ed3f2d747ed0afa240f027cd6fa8a26b090793e2a7804fb9
+  data.tar.gz: 3fabf752a22e46befa105e815e86964e1842c68e5d46f3d89c84f4a79be729103e893317c32d690999f28c6279c78aa5b5d39a377b76550caae35f2ba74a190c

data/README.md

@@ -1,5 +1,27 @@
 # master-crypt
 
+## Usage
+
+### Encrypting data with a master key
+```ruby
+master_key = "Very secure & random master k3y"
+other_secret_key = "Another very secure & random master k3y"
+data = "Secret data..."
+master_crypt = MasterCrypt.new(master_key)
+
+encrypted_data = master_crypt.master_key_encrypt(data, [other_secret_key])
+# encrypted_data can be decrypted with either the master_key or other_secret_key
+```
+
+### Decrypting data with a master key
+```ruby
+master_key = "Very secure & random master k3y"
+encrypted_data = "...."
+master_crypt = MasterCrypt.new(master_key)
+
+plaintext = master_crypt.master_key_decrypt(encrypted_data)
+```
+
 ## Development
 ```sh
 bundle install

data/lib/master_crypt.rb

@@ -3,11 +3,24 @@ require "rbnacl"
 require "base64"
 require "digest"
 
-module MasterCrypt
+class MasterCrypt
+  def initialize(master_key)
+    raise "Master key must not be blank" if master_key.nil? || master_key.empty?
+    @master_key = master_key
+  end
+
+  def master_key_encrypt(plaintext, secret_keys = [])
+    self.class.encrypt(plaintext, [@master_key] + Array(secret_keys))
+  end
+
+  def master_key_decrypt(encrypted_data)
+    self.class.decrypt(encrypted_data, @master_key)
+  end
+
   class << self
-    def encrypt(plaintext, secrets)
-      raise "Secrets must not be blank" unless secrets.select(&:empty?).empty?
-      raise "At least 1 secret is required" if !secrets.is_a?(Array) || secrets.empty?
+    def encrypt(plaintext, secret_keys)
+      raise "At least 1 secret key is required" if !secret_keys.is_a?(Array) || secret_keys.empty?
+      raise "Secret keys must not be blank" unless secret_keys.select(&:empty?).empty?
 
       random_key = RbNaCl::Random.random_bytes(RbNaCl::SecretBox.key_bytes)
       # encrypt data with random_key
@@ -17,7 +30,7 @@ module MasterCrypt
       encrypted_data64 = Base64.strict_encode64(encrypted_data)
 
       # encrypt random_kets with each secret
-      encrypted_random_keys64 = secrets.collect do |secret|
+      encrypted_random_keys64 = secret_keys.collect do |secret|
         key = generate_key_from_secret(secret)
         box = RbNaCl::SimpleBox.from_secret_key(key)
 

data/lib/master_crypt/version.rb

@@ -1,3 +1,3 @@
-module MasterCrypt
-  VERSION = "0.0.2"
+class MasterCrypt
+  VERSION = "0.0.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: master-crypt
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Cian McElhinney
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-01 00:00:00.000000000 Z
+date: 2021-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: standardrb
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.1
+        version: 0.13.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.1
+        version: 0.13.0
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement