encrypted-keystore 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f702b8696648c43bef8b8b61cf0da1c42b57e38a
-  data.tar.gz: 47b8ec4c2fd696497a1ddc1e84da6a4c84526d49
+  metadata.gz: 1efb8674ad2adb4e1357386f5a63059b6ff90658
+  data.tar.gz: bb5aa9f3ecd876dd115bbb47dd1ef083a701e0ed
 SHA512:
-  metadata.gz: c6dae5d82995e25913827aa3781d3a1b43a2ed7d5075b3ef1086602ec9db2c835b8aca6c42cbdeaef9879749176a7584862a17ef393fbf6f21911dd5e63c8d6d
-  data.tar.gz: aa2347013272c0a6bf155f9a07175cd7380b3200eb1f9b334866243342904760457d303844feafa4113784505a1eb5cc72c47d63a6090cc320714a92fa2d14c8
+  metadata.gz: 201b9ccb705b03a7dbd58ca334f30e4111973a9b62798687d111d673ab5cd22e7425a0edceb73bd6a0987a9cdf844ec848e2c75e30e769ac916a119d1f6997b1
+  data.tar.gz: 36283c5911154d859eb307e546648a4fc7c2448ceb27acc760d7d8e3b690692b9c4d76ee45f704d65bb446aaa45878ad705f5ca3e482d49c0fcbdd3f2fa0172b

data/Readme.md

@@ -1,52 +1,71 @@
-# Rails, Quietly
+# Encrypted Keystore
 
-A simple wrapper to suppress logging in various ways in Rails apps.
+A simple encrypted key storage system.
 
 ## Installation
 
 Add this to your Gemfile:
 
 ```ruby
-gem 'rails-quietly'
+gem 'encrypted-keystore'
 ```
 
 or install directly:
 
 ```bash
-gem install rails-quietly
+gem install encrypted-keystore
 ```
 
 ## Inclusion
 
-In `config/applicaiton.rb`, include the following:
+In `config/application.rb`, include the following:
 
 ```ruby
-require 'quietly'
-include Quietly::Local
+require 'encrypted_keystore'
 ```
 
-This puts the module into global scope.
-
 ## Usage
 
-You can either use the `quietly` method with a block:
+### Direct Construction
+
+Encrypt:
 
 ```ruby
-result_b = quietly do
-  a = ModelA.query
-  ModelB.query(a)
-end
+ek = EncryptedKeystore.new(
+  file: 'path/to/key.pem',
+  out: 'path/to/encrypted.pem.enc'
+)
+
+ek.encrypt
+key = ek.key
+iv = ek.iv
 ```
 
-or manually suppress and restore logging:
+Decrypt:
 
 ```ruby
-old_logger = go_quiet
-
-a = ModelA.query
-result_b = ModelB.query(a)
+ek = EncryptedKeystore.new(
+  file: 'path/to/encrypted.pem.enc',
+  out: 'path/to/key.pem',
+  key: key,
+  iv: iv
+)
+
+ek.decrypt
+```
 
-end_quiet(old_logger)
+### Class Methods
 
-result_b
+```ruby
+key_hash = EncryptedKeystore.encrypt(
+  file: 'path/to/key.pem',
+  out: 'path/to/encrypted.pem.enc'
+)
+
+EncryptedKeystore.decrypt(
+  file: 'path/to/encrypted.pem.enc',
+  out: 'path/to/key.pem',
+  key: key,
+  iv: iv
+)
 ```

data/encrypted-keystore.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name          = 'encrypted-keystore'
-  s.version       = '0.0.3'
+  s.version       = '0.0.4'
   s.date          = '2019-06-26'
   s.summary       = 'Simple key encrypter/decrypter'
   s.description   = 'A simple encrypted key storage system.'

data/lib/encrypted_keystore.rb

@@ -6,6 +6,18 @@ class EncryptedKeystore
 
   attr_accessor :file, :out, :key, :iv
 
+  def self.encrypt(file, out)
+    enc = new(file: file, out: out)
+    enc.encrypt
+
+    { key: enc.key, iv: enc.iv }
+  end
+
+  def self.decrypt(file, out, key, iv)
+    enc = new(file: file, out: out, key: key, iv: iv)
+    enc.decrypt
+  end
+
   def initialize(file: nil, out: nil, key: nil, iv: nil)
     @file = file
     @out = out

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: encrypted-keystore
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Julian Fiander