covert 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 90aa90ca29e52c1a1310fac23fd33c1f31b369d2ae6f8356963c30f7810a6862
-  data.tar.gz: 662422c58628c014f87fcd53e440c4d55b9b5d41a01051f4c9eb7c77b3c39e70
+  metadata.gz: 69d9e93d903d41b36fa34c2984440225a18c68c837abb58f79a7ecfe452a0994
+  data.tar.gz: 52fdf5e022870b6ab6b1c6ff6798dbbaa2882e8964387091d1fa3db3c76f5c3b
 SHA512:
-  metadata.gz: 1284badb03b840c79449ef139fbd864a9b984cbb9d3cfcbfbd1518f1fa2833aac053ee5716b87b7566b1654ec75f2847230d31b1f0cff76787a8414c4881e7b6
-  data.tar.gz: 1c22ecd1222ba5b07c5b252f9175dd39b722192c9c170aee69ff751fe3d60a20e88c4e4fa4c644eae8cdcda551d7720b7d7ba86cced3181294bdc840f5384f74
+  metadata.gz: 883171eb85fad23570d86d12580ba690d0a1c4ba04b731b337df402bb7cf9cc2f245d8bda5576d205b0f7b7af9ac847d7b58b3fc872e317e87ecfe324cfdc2aa
+  data.tar.gz: 3973ceab4a67822d7be4dc2b8bbbd4d44bc3d0b06df06b86f5e01720af3f6d5930ebcf8d98c747363930dcc7591973d9c30b3145bd9a0f3fa2df2402239ce4e2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    covert (0.1.0)
+    covert (0.2.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,5 +1,8 @@
 # Covert
 
+[![CircleCI](https://circleci.com/gh/merqloveu/covert.svg?style=svg)](https://circleci.com/gh/merqloveu/covert)
+[![Gem Version](https://badge.fury.io/rb/covert.svg)](https://badge.fury.io/rb/covert)
+
 Covert makes your string securely obfuscated.
 
 ## Installation
@@ -25,6 +28,8 @@ Or install it yourself as:
 Covert.configure do |config|
   config.cipher_key = 'blah!'
   config.cipher = 'AES-256-CBC' # default
+  config.hmac_key = 'blah!'
+  config.hmac_digest = 'SHA256' # default
 end
 ```
 
@@ -38,6 +43,56 @@ Covert.obfuscate('mystring') #=> "7hSfzDwp2JXZcieFpGCndA=="
 Covert.unobfuscate('7hSfzDwp2JXZcieFpGCndA==') #=> "mystring"
 ```
 
+### Hmac
+```ruby
+Covert.hmac('hmac') #=> "13ca4d5b9cdc1485834a05d926913d919d3c83de29c99314a7dbccafdc8be8ac"
+```
+
+## Benchmark
+
+Comparison with gem `obfuscate` with Blowfish algo.
+
+```ruby
+require 'obfuscate'
+require 'covert'
+require 'benchmark'
+require 'securerandom'
+
+Obfuscate.setup :salt => 'a very weak salt indead.'
+
+Covert.configure do |config|
+  config.cipher_key = 'blah!'
+end
+
+puts Benchmark.bm { |bm|
+  ids = []
+  bm.report("obfuscate x1000:") {
+    1000.times { ids << Obfuscate.obfuscate( SecureRandom.uuid, {:mode => :block} ) }
+  }
+
+  bm.report("clarify x1000:") {
+    ids.each { |id| Obfuscate.clarify( id, {:mode => :block} ) }
+  }
+
+  ids = []
+  bm.report("myobfuscate x1000:") {
+    1000.times { ids << Covert.obfuscate(SecureRandom.uuid) }
+  }
+
+  bm.report("myclarify x1000:") {
+    ids.each { |id| Covert.unobfuscate(id) }
+  }
+}
+```
+
+```shell
+                            user       system     total       real
+Obfuscate.obfuscate x1000:  7.883860   0.044474   7.928334 (  7.944916)
+Obfuscate.clarify   x1000:  7.841752   0.016152   7.857904 (  7.873886)
+Covert.obfuscate    x1000:  0.011217   0.012656   0.023873 (  0.024485)
+Covert.unobfuscate  x1000:  0.003891   0.000358   0.004249 (  0.004359)
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/covert/config.rb

@@ -5,11 +5,13 @@ module Covert
   # Covert configuration
   #
   class Config
-    attr_accessor :cipher_key, :cipher
+    attr_accessor :cipher_key, :cipher, :hmac_key, :hmac_digest
 
     def initialize
       @cipher_key = nil
       @cipher = 'AES-256-CBC'
+      @hmac_key = nil
+      @hmac_digest = 'SHA256'
     end
   end
 end

data/lib/covert/hmac.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Covert
+  class Hmac
+    class << self
+      def call(value:)
+        new(value).call
+      end
+    end
+
+    def initialize(value)
+      @value = value
+    end
+
+    def call
+      OpenSSL::HMAC.hexdigest(digest, key, value)
+    end
+
+    private
+
+    attr_reader :value
+
+    def key
+      Covert.config.hmac_key
+    end
+
+    def digest
+      Covert.config.hmac_digest
+    end
+  end
+end

data/lib/covert/version.rb

@@ -1,3 +1,3 @@
 module Covert
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/covert.rb

@@ -9,6 +9,7 @@ module Covert
   class Error < StandardError; end
 
   autoload :Config, 'covert/config.rb'
+  autoload :Hmac, 'covert/hmac.rb'
   autoload :Obfuscation, 'covert/obfuscation.rb'
   autoload :Obfuscate, 'covert/obfuscate.rb'
   autoload :Unobfuscate, 'covert/unobfuscate.rb'
@@ -31,6 +32,14 @@ module Covert
     end
   end
 
+  # @param [String] str String for HMAC encoding
+  # @example Generate HMAC code
+  #   Covert.hmac("mystring") #=> "cddb0db23f469c8bf072b21fd837149bd6ace9ab771cceef14c9e517cc93282e"
+  # @return [String] HMAC encoded string
+  def self.hmac(str)
+    Hmac.call(value: str)
+  end
+
   # @param [String] str String to obfuscate
   # @example Obfuscate a String
   #   Covert.obfuscate("mystring") #=> "7hSfzDwp2JXZcieFpGCndA=="

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: covert
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Alexander Merkulov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-22 00:00:00.000000000 Z
+date: 2022-02-19 00:00:00.000000000 Z
 dependencies: []
 description: Fast & secure way to provide obfuscated ids and text.
 email:
@@ -30,6 +30,7 @@ files:
 - covert.gemspec
 - lib/covert.rb
 - lib/covert/config.rb
+- lib/covert/hmac.rb
 - lib/covert/obfuscate.rb
 - lib/covert/obfuscation.rb
 - lib/covert/unobfuscate.rb