opensecret 0.0.913 → 0.0.941

data/lib/usecase/usecases/on.rb

@@ -0,0 +1,33 @@
+#!/usr/bin/ruby
+	
+module OpenSecret
+
+# This is the [On] usecase that is triggered when a user would like
+# to start a locking (encryption) session.
+#
+# Pre-Conditions
+#
+# - [session.config.file] exists with domain,user,email,store_id => store_url
+# -
+# -
+#
+#
+# Main Flow of Events
+#
+# -
+# -
+#
+class On < OpenSession::UseCase
+
+
+  def execute
+
+
+  end
+
+
+end
+
+
+end
+

data/lib/usecase/usecases/safe.rb

@@ -0,0 +1,95 @@
+#!/usr/bin/ruby
+	
+module OpenSecret
+
+  require "usecase/usecase"
+  require "session/attributes"
+
+  # This is the [On] usecase that is triggered when a user would like
+  # to start a locking (encryption) session.
+  #
+  # Pre-Conditions
+  #
+  # - [session.config.file] exists with domain,user,email,store_id => store_url
+  # -
+  # -
+  #
+  #
+  # Main Flow of Events
+  #
+  # -
+  # -
+  #
+  class Safe < OpenSession::UseCase
+
+    attr_writer :safe_path
+    @@context_name = "opensecret"
+    @@prime_name = "opensecret.safe"
+    
+
+    def execute
+
+      
+      OpenSession::Attributes.stash @@context_name, "safe", @safe_path
+      FileUtils.mkdir_p @safe_path unless File.exists? @safe_path
+
+    end
+
+
+    def pre_validation
+
+      needs_chopping = @safe_path.end_with?("/") || @safe_path.end_with?("\\")
+      @safe_path = @safe_path.chop if needs_chopping
+
+      index_1st = @safe_path.index @@prime_name
+      index_2nd = @safe_path.rindex @@prime_name
+
+      xtra_msg = "Text [ #{@@prime_name} ] can only appear once in [ #{@safe_path} ]."
+      raise SafePrimeNameRepeated.new xtra_msg, @safe_path unless index_1st == index_2nd
+
+      unless @safe_path.end_with? @@prime_name
+
+        if @safe_path.include? @@prime_name
+          prime_name_end_index = @safe_path.index(@@prime_name) + @@prime_name.length
+          @safe_path = @safe_path[0..prime_name_end_index]
+        else
+          @safe_path = File.join @safe_path, @@prime_name
+        end
+
+        ends_with_prime = @safe_path.end_with? @@prime_name          
+        not_at_end_msg = "Text [#{@@prime_name} ] is not at end of [ #{@safe_path} ]."
+        raise SafePrimeNameNotAtEnd.new not_at_end_msg, @safe_path unless ends_with_prime
+
+      end
+
+      if( File.exists?( @safe_path ) && !(File.directory? @safe_path) )
+        raise SafeDirectoryIsFile.new "the [safe] directory path points to a file", @safe_path
+      end
+
+    end
+
+
+    # The safe_path instance attribute must be configured within
+    # the context configuration file using a keyname of "safe".
+    #
+    # @raise ArgumentError for any one of a long list of reasons that
+    #     cause the key value to not be retrieved. This can range from
+    #     non-existent directories and files, non readable files, incorrect
+    #     configurations right down to missing keys or even missing values.
+    def post_validation
+
+      configured_path = OpenSession::Attributes.instance.get_value @@context_name, "safe"
+      path_string_1 = "  path 1 => #{configured_path}"
+      path_string_2 = "  path 2 => #{@safe_path}"
+      mismatch_path = "Path mismatch to opensecret [safe] detected."
+      err_msg = "\n" + mismatch_path + "\n" + path_string_1 + "\n" + path_string_2 + "\n"
+
+      raise RuntimeError, err_msg unless @safe_path.eql? configured_path
+
+
+    end
+
+  end
+
+
+end

data/lib/version.rb

@@ -1,3 +1,3 @@
 module OpenSecret
-  VERSION = "0.0.913"
+  VERSION = "0.0.941"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opensecret
 version: !ruby/object:Gem::Version
-  version: 0.0.913
+  version: 0.0.941
 platform: ruby
 authors:
 - Apollo Akora
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-11 00:00:00.000000000 Z
+date: 2018-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: inifile
@@ -93,6 +93,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- ".yardopts"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -100,15 +101,21 @@ files:
 - Rakefile
 - bin/opensecret
 - lib/config.opensecret.ini
+- lib/crypto/amalgam.rb
+- lib/crypto/collect.rb
+- lib/crypto/engineer.rb
+- lib/crypto/verify.rb
+- lib/extension/array.rb
+- lib/extension/dir.rb
+- lib/extension/file.rb
+- lib/extension/hash.rb
+- lib/extension/string.rb
+- lib/factbase/facts.opensecret.io.ini
+- lib/logging/gem.logging.rb
 - lib/opensecret.rb
-- lib/opensecret/additions/array.rb
-- lib/opensecret/additions/dir.rb
-- lib/opensecret/additions/string.rb
-- lib/opensecret/commons/eco.cmdline.rb
 - lib/opensecret/commons/eco.faculty.rb
 - lib/opensecret/commons/eco.system.rb
 - lib/opensecret/commons/eco.systems.rb
-- lib/opensecret/eco.do.rb
 - lib/opensecret/executors/crypt.keys/crypt.keys.ini
 - lib/opensecret/executors/crypt.keys/crypt.keys.rb
 - lib/opensecret/executors/decrypt/decrypt.ini
@@ -123,19 +130,17 @@ files:
 - lib/opensecret/factbase/readme.md
 - lib/opensecret/factbase/retired.facts/maven.database.ide.facts.ini
 - lib/opensecret/factbase/retired.facts/s3-upload-block-facts.ini
-- lib/opensecret/plugins.io/cipher/crypto.rb
-- lib/opensecret/plugins.io/error/eco.exceptions.rb
-- lib/opensecret/plugins.io/facts/fact.chars.rb
-- lib/opensecret/plugins.io/facts/fact.factor.rb
-- lib/opensecret/plugins.io/facts/fact.locator.rb
-- lib/opensecret/plugins.io/facts/fact.reader.rb
-- lib/opensecret/plugins.io/facts/fact.tree.rb
 - lib/opensecret/plugins.io/file/file.rb
 - lib/opensecret/plugins.io/git/git.flow.rb
-- lib/opensecret/plugins.io/logs/log.object.rb
-- lib/opensecret/plugins.io/logs/logging.rb
-- lib/session/session.rb
+- lib/session/attributes.rb
+- lib/session/exceptions.rb
+- lib/session/fact.finder.rb
 - lib/session/time.stamp.rb
+- lib/session/user.home.rb
+- lib/usecase/usecase.rb
+- lib/usecase/usecases/init.rb
+- lib/usecase/usecases/on.rb
+- lib/usecase/usecases/safe.rb
 - lib/version.rb
 - opensecret.gemspec
 homepage: https://www.eco-platform.co.uk

data/lib/opensecret/additions/array.rb

@@ -1,117 +0,0 @@
-#!/usr/bin/ruby
-
-# --
-# -- Reopen the core ruby Array class and add the below methods to it.
-# --
-# -- Case Sensitivity rules for [ALL] the below methods that are
-# -- added to the core Ruby string class.
-# --
-# -- For case insensitive behaviour make sure you downcase both the
-# -- string object and the parameter strings (or strings within
-# -- other parameter objects, like arrays and hashes).
-# --
-class Array
-
-  # --
-  # -- Get the text [in between] this and that delimeter [exclusively].
-  # -- Exclusively means the returned text [does not] include either of
-  # -- the matched delimeters (although an unmatched instance of [this]
-  # -- delimeter may appear in the in-between text).
-  # --
-  # -- --------------------
-  # -- Multiple Delimiters
-  # -- --------------------
-  # --
-  # -- When multiple delimiters exist, the text returned is in between the
-  # --
-  # --  [a] - first occurrence of [this] delimeter AND the
-  # --  [b] - 1st occurrence of [that] delimeter [AFTER] the 1st delimiter
-  # --
-  # -- Instances of [that] delimiter occurring before [this] are ignored.
-  # -- The text could contain [this] delimeter instances but is guaranteed
-  # -- not to contain a [that] delimeter.
-  # --
-  # -- -----------
-  # -- Parameters
-  # -- -----------
-  # --
-  # --   this_delimiter : begin delimeter (not included in returned string)
-  # --   that_delimiter : end delimeter (not included in returned string)
-  # --
-  # -- -----------
-  # -- Exceptions
-  # -- -----------
-  # --
-  # -- An exception (error) will be thrown if
-  # --
-  # --   => any nil (or empties) exist in the input parameters
-  # --   => [this] delimeter does not appear in the in_string
-  # --   => [that] delimeter does not appear after [this] one
-  # --
-  def before_and_after begin_delimeter, end_delimeter
-
-    Throw.if_nil_or_empty_strings [ self, begin_delimeter, end_delimeter ]
-
-    before_after_lines = []
-    in_middle_bit = false
-
-    self.each do |candidate_line|
-
-      is_middle_boundary = !in_middle_bit && candidate_line.downcase.include?(begin_delimeter.downcase)
-      if is_middle_boundary
-        in_middle_bit = true
-        next
-      end
-
-      unless in_middle_bit
-        before_after_lines.push candidate_line
-        next
-      end
-
-      #--
-      #-- Now we are definitely in the middle bit.
-      #-- Let's check for the middle end delimeter
-      #--
-      if candidate_line.downcase.include? end_delimeter.downcase
-        in_middle_bit = false
-      end
-
-    end
-
-    return before_after_lines
-
-  end
-
-
-  def middlle_bit begin_delimeter, end_delimeter
-
-    Throw.if_nil_or_empty_strings [ self, begin_delimeter, end_delimeter ]
-
-    middle_lines = []
-    in_middle_bit = false
-
-    self.each do |candidate_line|
-
-      is_middle_boundary = !in_middle_bit && candidate_line.downcase.include?(begin_delimeter.downcase)
-      if is_middle_boundary
-        in_middle_bit = true
-        next
-      end
-
-      end_of_middle = in_middle_bit && candidate_line.downcase.include?(end_delimeter.downcase)
-      return middle_lines if end_of_middle
-      
-      #--
-      #-- We are definitely in the middle bit.
-      #--
-      middle_lines.push(candidate_line) if in_middle_bit
-
-    end
-
-    unreachable_str = "This point should be unreachable unless facts are ended."
-    raise RuntimeError.new unreachable_str
-
-  end
-
-
-end

data/lib/opensecret/additions/string.rb

@@ -1,312 +0,0 @@
-#!/usr/bin/ruby
-
-# --
-# -- Reopen the core ruby String class and add the below methods to it.
-# --
-# -- Case Sensitivity rules for [ALL] the below methods that are
-# -- added to the core Ruby string class.
-# --
-# -- For case insensitive behaviour make sure you downcase both the
-# -- string object and the parameter strings (or strings within
-# -- other parameter objects, like arrays and hashes).
-# --
-class String
-
-  # --
-  # -- Get the text [in between] this and that delimeter [exclusively].
-  # -- Exclusively means the returned text [does not] include either of
-  # -- the matched delimeters (although an unmatched instance of [this]
-  # -- delimeter may appear in the in-between text).
-  # --
-  # -- --------------------
-  # -- Multiple Delimiters
-  # -- --------------------
-  # --
-  # -- When multiple delimiters exist, the text returned is in between the
-  # --
-  # --  [a] - first occurrence of [this] delimeter AND the
-  # --  [b] - 1st occurrence of [that] delimeter [AFTER] the 1st delimiter
-  # --
-  # -- Instances of [that] delimiter occurring before [this] are ignored.
-  # -- The text could contain [this] delimeter instances but is guaranteed
-  # -- not to contain a [that] delimeter.
-  # --
-  # -- -----------
-  # -- Parameters
-  # -- -----------
-  # --
-  # --   this_delimiter : begin delimeter (not included in returned string)
-  # --   that_delimiter : end delimeter (not included in returned string)
-  # --
-  # -- -----------
-  # -- Exceptions
-  # -- -----------
-  # --
-  # -- An exception (error) will be thrown if
-  # --
-  # --   => any nil (or empties) exist in the input parameters
-  # --   => [this] delimeter does not appear in the in_string
-  # --   => [that] delimeter does not appear after [this] one
-  # --
-  def in_between this_delimeter, that_delimeter
-
-    Throw.if_nil_or_empty_strings [ self, this_delimeter, that_delimeter ]
-
-    scanner_1 = StringScanner.new self
-    scanner_1.scan_until /#{this_delimeter}/
-    scanner_2 = StringScanner.new scanner_1.post_match
-    scanner_2.scan_until /#{that_delimeter}/
-
-    in_between_text = scanner_2.pre_match.strip
-    log.info(ere){ in_between_text }
-
-    return in_between_text
-
-# --> file_text = File.read "c:/Users/apollo13/mirror.techwiki/documents/collaboration-tech/gollum/gollum-certbot-ssl.md"
-
-# --> this_delimeter = "<!-- facts"
-# --> that_delimeter = "-->"
-
-# --> scanner = StringScanner.new file_text
-# --> log.info(ere){ "1st Delimiter => #{this_delimeter}" }
-# --> log.info(ere){ "2nd Delimiter => #{that_delimeter}" }
-# --> before_text = scanner.scan_until /#{this_delimeter}/
-# --> post_match_text = scanner.post_match
-# --> scanner2 = StringScanner.new post_match_text
-# --> scanner2.scan_until /#{that_delimeter}/
-# --> best_text = scanner2.pre_match.strip
-
-# --> best_text = Strings.in_between file_text, this_delimeter, that_delimeter
-
-# --> log.info(ere){ "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@" }
-# --> log.info(ere){ "What We Want" }
-# --> log.info(ere){ "======================================================" }
-# --> log.info(ere){ best_text }
-# --> log.info(ere){ "======================================================" }
-
-# --> exit
-
-  end
-
-
-  # --
-  # -- Return true if the [little string] within this
-  # -- string object is both
-  # --
-  # --  a] topped by the parameter prefix AND
-  # --  b] tailed by the parameter postfix
-  # --
-  # -- -----------------------------------------
-  # -- In the below example [true] is returned
-  # -- -----------------------------------------
-  # --
-  # --   This [String] => "Hey [<-secrets->] are juicy."
-  # --   little string => "secrets"
-  # --   topped string => "[<-"
-  # --   tailed string => "->]"
-  # --
-  # -- Why true? Because the little string "secret" is
-  # -- (wrapped) topped by "[<-" and tailed by "->]"
-  # --
-  # -- -----------------------------------------
-  # -- Assumptions | Constraints | Boundaries
-  # -- -----------------------------------------
-  # --
-  # --   - all matches are [case sensitive]
-  # --   - this string must contain little_str
-  # --   - one strike and its true
-  # --       (if little string appears more than once)
-  # --       so => "all secrets, most [<-secrets->] r juicy"
-  # --          => true as long as (at least) one is wrapped
-  # --
-  # --
-  def has_wrapped? little_str, prefix, postfix
-
-    return self.include?( prefix + little_str + postfix )
-
-  end
-
-  
-  # --
-  # -- Sandwich the first occurrence of a substring in
-  # -- this string with the specified pre and postfix.
-  # --
-  # -- This string contains the little string and an
-  # -- IN-PLACE change is performed with the first
-  # -- occurrence of the little string being prefixed
-  # -- and postfixed with the 2 parameter strings.
-  # --
-  # -- ----------------------------------
-  # -- Example of sandwiching [wrapping]
-  # -- ----------------------------------
-  # --
-  # --   [String]  => "Hey secrets are juicy."
-  # --   [To_Wrap] => "secrets"
-  # --   [Prefix]  => "[<-"
-  # --   [Postfix] => "->]"
-  # --
-  # --   [String]  => "Hey [<-secrets->] are juicy."
-  # --
-  # -- This string IS changed in place.
-  # --
-  def sandwich_substr to_wrap_str, prefix, postfix
-
-    occurs_index = self.downcase.index to_wrap_str.downcase
-    self.insert occurs_index, prefix
-    shifted_index = occurs_index + prefix.length + to_wrap_str.length
-    self.insert shifted_index, postfix
-
-  end
-
-  
-  # --
-  # -- Return [TRUE] if this string includes [every word] harboured
-  # -- by the parameter array, else return [FALSE]. The "include"
-  # -- is a case-sensitive search.
-  # --
-  # -- -----------
-  # -- Parameter
-  # -- -----------
-  # --
-  # --   word_array : array of string words for the inclusivity test
-  # --
-  # -- --------------------------------
-  # -- Dependencies and Assumptions
-  # -- --------------------------------
-  # --
-  # --   the parameter string is not nil
-  # --   array can be [empty] but not nil
-  # --   array contents are neither nil nor empty
-  # --
-  def includes_all? word_array
-
-    Throw.if_nil self
-    Throw.if_nil word_array
-
-    word_array.each do |word|
-
-      Throw.if_nil word
-      return false unless self.include? word
-
-    end
-
-    return true
-
-  end
-
-
-  # --
-  # -- return true if the string includes [ANY] word within the
-  # -- parameter array, else return false. The "include" is done
-  # -- as a case-sensitive search.
-  # --
-  # -- -----------
-  # -- Parameter
-  # -- -----------
-  # --
-  # --   word_array : array of string words for the inclusivity test
-  # --
-  # -- --------------------------------
-  # -- Dependencies and Assumptions
-  # -- --------------------------------
-  # --
-  # --   array can be [empty] but not nil
-  # --   array contents are neither nil nor empty
-  # --
-  def includes_any? word_array
-
-    Throw.if_nil self
-    Throw.if_nil word_array
-
-    word_array.each do |word|
-
-      Throw.if_nil word
-      return true if self.include? word
-
-    end
-
-    return false
-
-  end
-
-
-  # --
-  # -- Encrypt this string with the parameter encryption/decryption key
-  # -- and return the encrypted text as a new string.
-  # --
-  # --  decrypt_key  => the key that will decrypt the output string
-  # --
-  # --
-  def encrypt decrypt_key
-
-## ----> Write a RE-CRYPT method that goes through a folder - decrypting and recrypting
-## ----> Write a RE-CRYPT method that goes through a folder - decrypting and recrypting
-## ----> Write a RE-CRYPT method that goes through a folder - decrypting and recrypting
-## ----> Write a RE-CRYPT method that goes through a folder - decrypting and recrypting
-
-###### ON Linux improve by changing to OpenSSL::Cipher.new('DES-EDE3-CBC').encrypt
-###### ON Linux improve by changing to Digest::SHA2.hexdigest decrypt_key
-###### ON Linux improve by changing to OpenSSL::Cipher.new('DES-EDE3-CBC').encrypt
-###### ON Linux improve by changing to Digest::SHA2.hexdigest decrypt_key
-###### ON Linux improve by changing to OpenSSL::Cipher.new('DES-EDE3-CBC').encrypt
-###### ON Linux improve by changing to Digest::SHA2.hexdigest decrypt_key
-###### ON Linux improve by changing to OpenSSL::Cipher.new('DES-EDE3-CBC').encrypt
-###### ON Linux improve by changing to Digest::SHA2.hexdigest decrypt_key
-
-    cipher = OpenSSL::Cipher::Cipher.new('DES-EDE3-CBC').encrypt
-    cipher.key = Digest::SHA1.hexdigest decrypt_key
-    crypted = cipher.update(self) + cipher.final
-    encrypted_text = crypted.unpack('H*')[0].upcase
-
-    return encrypted_text
-
-  end
-
-
-  # --
-  # -- Decrypt this string with the parameter encryption/decryption key
-  # -- and return the decrypted text as a new string.
-  # --
-  # --  encrypt_key  => the key the input string was encrypted with
-  # --
-  # --
-  def decrypt encrypt_key
-
-## ----> Write a RE-CRYPT method that goes through a folder - decrypting and recrypting
-## ----> Write a RE-CRYPT method that goes through a folder - decrypting and recrypting
-## ----> Write a RE-CRYPT method that goes through a folder - decrypting and recrypting
-## ----> Write a RE-CRYPT method that goes through a folder - decrypting and recrypting
-
-###### ON Linux improve by changing to OpenSSL::Cipher.new('DES-EDE3-CBC').encrypt
-###### ON Linux improve by changing to Digest::SHA2.hexdigest decrypt_key
-###### ON Linux improve by changing to OpenSSL::Cipher.new('DES-EDE3-CBC').encrypt
-###### ON Linux improve by changing to Digest::SHA2.hexdigest decrypt_key
-###### ON Linux improve by changing to OpenSSL::Cipher.new('DES-EDE3-CBC').encrypt
-###### ON Linux improve by changing to Digest::SHA2.hexdigest decrypt_key
-
-    cipher = OpenSSL::Cipher::Cipher.new('DES-EDE3-CBC').decrypt
-    cipher.key = Digest::SHA1.hexdigest encrypt_key
-    uncrypted = [self].pack("H*").unpack("C*").pack("c*")
-    decrypted_text = cipher.update(uncrypted) + cipher.final
-
-    return decrypted_text
-
-  end
-
-
-  # --
-  # -- Log the string which is expected to be delineated.
-  # -- If the string originated from a file it will be logged
-  # -- line by line. If no line delineation the string will be
-  # -- dumped just as a blob.
-  # --
-  def log_lines
-
-    self.each_line do |line|
-      clean_line = line.chomp.gsub("\\n","")
-      log.info(ere) { line } if clean_line.length > 0
-    end
-
-  end
-
-end