opensecret 0.0.9925 → 0.0.9949

data/lib/usecase/login.rb

@@ -2,8 +2,6 @@
 	
 module OpenSecret
 
-  require 'openssl'
-
   # The <b>login use case</b> is given the domain name and if needs be
   # it collects the password then (if correct) logs the user in.
   #
@@ -12,11 +10,12 @@ module OpenSecret
   # - its domain name parameter is mandatory
   # - it is called at the start of every session
   # - it is undone by the logout command
-  # - it requires the OPEN_SESSION_TOKEN environment variable
+  # - it requires the shell token environment variable to be set
   # - you can nest login commands thus using multiple domains
   # - you can call it with a --with=password switch
+  # - a space before the command prevents it being logged in .bash_history
   # - you can deliver the password in multiple ways
-  class Login < Command
+  class Login < UseCase
 
     attr_writer :master_p4ss, :domain_name
 
@@ -46,7 +45,9 @@ module OpenSecret
 ############## Use [[ KeyApi.valid_password? ]] and give error if not valid
 
       OpenKey::KeyApi.do_login( @domain_name, domain_secret, create_header() )
-      print_login_success
+
+      view_uc = View.new
+      view_uc.flow_of_events
 
     end
 

data/lib/usecase/logout.rb

@@ -2,9 +2,7 @@
 	
 module OpenSecret
 
-  require 'openssl'
-
-  class Logout < Command
+  class Logout < UseCase
 
     def execute
 

data/lib/usecase/open.rb

@@ -2,8 +2,6 @@
 	
 module OpenSecret
 
-  require 'openssl'
-
   # The <tt>open use case</tt> allows us to add (put), subtract (del)ete, change
   # (update) and list the secrets within an envelope (outer path) at a given
   # position (inner path), whether that envelope exists or not.
@@ -18,16 +16,6 @@ module OpenSecret
   # single colon separating the outer (path to envelope) from the inner (path
   # within envelope).
   #
-  #    ops open aws.credentials:s3reader
-  #
-  # The outer and inner paths can contain forward slashes that segment the path.
-  #
-  #    ops open production/aws.credentials:s3/s3reader
-  #    ops put access_key ABCD1234
-  #    ops put secret_key FGHIJ56789
-  #    ops put region_key eu-central-1
-  #    ops seal
-  #
   # == Open (Path) Pre-Conditions
   #
   # The domain must have been initialized on this machine stating the path to
@@ -36,13 +24,11 @@ module OpenSecret
   # To open a path these conditions must be true.
   #
   # - the shell session token must have been set at the session beginning
-  # - a successful <tt>ops login</tt> command must have been issued
+  # - a successful <tt>login</tt> command must have been issued
   # - the external drive (eg usb key) must be configured and accessible
   #
   # == Observable Value
   #
-  #     $ ops open home/wifi
-  #
   # The observable value delivered by +[open]+ boils down to
   #
   # - an openkey (eg asdfx1234) and corresponding open encryption key
@@ -53,7 +39,7 @@ module OpenSecret
   #     [session]
   #     base.path = home/wifi
   #
-  class Open < Command
+  class Open < UseCase
 
     # The two paths that have been posted to the open command.
     # First is a relative path to the obfuscated envelope and then
@@ -63,59 +49,18 @@ module OpenSecret
     def execute
 
       return unless ops_key_exists?
-      appdb_content = OpenKey::KeyApi.read_app_content()
-
-      puts "---\n"
-      puts "--- The Master Database (Before)\n"
-      puts "---\n"
-      puts JSON.pretty_generate( appdb_content )
-      puts "---\n"
-
-      appdb_content[ ENV_PATH ] = @env_path
-      appdb_content[ KEY_PATH ] = @key_path
-
-      puts "---\n"
-      puts "--- The Master Database (After)\n"
-      puts "---\n"
-      puts JSON.pretty_generate( appdb_content )
-      puts "---\n"
-
-      OpenKey::KeyApi.write_app_content( create_header(), appdb_content )
-      print_open_success
-
-      return
-
-    end
-
-
-    private
-
-
-    def print_open_success
-
-      puts ""
-      puts "Success opening a path to a data bucket."
-      puts "You can now put data into a dictionary or"
-      puts "add it to a list or set a scalar value."
-      puts ""
-      puts "    ops put aws.iam.usr joebloggs"
-      puts "    ops put access.key ABCD1234"
-      puts "    ops put secret.key FGHIJ56789"
-      puts "    ops put region.key eu-central-1"
-      puts "    ops close"
-      puts ""
-
-    end
+      master_db = OpenKey::KeyApi.read_master_db()
 
+      master_db[ ENV_PATH ] = @env_path
+      master_db[ KEY_PATH ] = @key_path
 
-    # Perform pre-conditional validations in preparation to executing the main flow
-    # of events for this use case. This method may throw the below exceptions.
-    #
-    # @raise [SafeDirNotConfigured] if the safe's url has not been configured
-    # @raise [EmailAddrNotConfigured] if the email address has not been configured
-    # @raise [StoreUrlNotConfigured] if the crypt store url is not configured
-    def pre_validation
+      OpenKey::KeyApi.write_master_db( create_header(), master_db )
 
+      # Show the mini dictionary at the opened chapter and verse location
+      # More work is needed when for when only the chapter is opened in
+      # which case we should show the list of verses and perhaps the count
+      # of key value pairs each verse contains.
+      Show.new.flow_of_events
 
     end
 

data/lib/usecase/print.rb

@@ -0,0 +1,40 @@
+#!/usr/bin/ruby
+	
+module OpenSecret
+
+  class Print < UseCase
+
+    attr_writer :key_name
+
+    def get_chapter_data( chapter_key )
+      return OpenKey::KeyDb.from_json( OpenKey::KeyApi.content_unlock( chapter_key ) )
+    end
+
+    def execute
+
+      return unless ops_key_exists?
+
+      master_db = get_master_database()
+
+      return if unopened_envelope?( master_db )
+
+      chapter_id = ENVELOPE_KEY_PREFIX + master_db[ ENV_PATH ]
+      has_chapter = OpenKey::KeyApi.db_envelope_exists?( master_db[ chapter_id ] )
+
+      chapter_data = get_chapter_data( master_db[ chapter_id ] ) if has_chapter
+      has_verse = has_chapter && chapter_data.has_key?( master_db[ KEY_PATH ] )
+
+      chapter_err_msg = "Nothing was found at chapter " + master_db[ ENV_PATH ]
+      raise ArgumentError, chapter_err_msg unless has_chapter
+      verse_err_msg = "Nothing was found at chapter " + master_db[ ENV_PATH ] + " verse " + master_db[ KEY_PATH ]
+      raise ArgumentError, verse_err_msg unless has_verse
+
+      print chapter_data[ master_db[ KEY_PATH ] ][ @key_name ]
+
+    end
+
+
+  end
+
+
+end

data/lib/usecase/put.rb

@@ -2,8 +2,6 @@
 	
 module OpenSecret
 
-  require 'openssl'
-
   # The <b>put use case</b> follows <b>open</b> and it adds secrets into an
   # <em>(encrypted at rest)</em> <b>envelope</b>. Put can be called many times
   # and when done, the <b>lock use case</b> can be called to commit all opened
@@ -27,172 +25,52 @@ module OpenSecret
   # - a new group_name/key_name (like monica/surname) entry is added if required
   # - a secret value is added against the key or updated if it already exists
   # - a new session id and encryption key is generated and used to re-encrypt
-  #
-  # == Example | Bill Clinton's Secrets
-  #
-  # In our fictitious example Bill Clinton uses opensecret to lock away the
-  # names and dates of his lady friends.
-  #
-  #    $ opensecret init bill.clinton@example.com
-  #    $ opensecret open my/friends
-  #
-  #    $ opensecret put monica/surname lewinsky
-  #    $ opensecret put monica/from "April 1989"
-  #    $ opensecret put monica/to "September 1994"
-  #
-  #    $ opensecret put hilary/surname clinton
-  #    $ opensecret put hilary/from "January 1988"
-  #    $ opensecret put hilary/to "Present Day"
-  #
-  #    $ opensecret lock
-  #
-  # Soon follow up use cases will be unveiled, enabling us to
-  #
-  # - <b>get</b>
-  # - <b>read</b>
-  # - <b>list</b>
-  # - <b>look</b>
-  # - <b>peep</b> and
-  # - <b>peek</b>
-  class Put < Command
-
+  class Put < UseCase
 
     attr_writer :secret_id, :secret_value
 
-
-    # The <b>put use case</b> follows <b>open</b> and it adds secrets into an
-    # <em>(encrypted at rest)</em> envelope. Put can be called many times to
-    # add secrets. Finally the <b>lock use case</b> commits all opened secrets
-    # into the configured storage engines.
-    #
-    # Calling <em>put</em> <b>before</b> calling open or <b>after</b> calling lock
-    # is not allowed and will result in an error.
-    #
-    # == Put Pre-Conditions
-    #
-    # When the put use case is called - the below conditions ring true.
-    #
-    # - the <b>folder path</b> ending in ../../my must exist
-    # - a session id, filename and encryption key ( in workstation config )
-    #
-    # == Observable Value
-    #
-    # The observable value delivered by +put+ boils down to
-    #
-    # - a new <b>friends.xyz123abc.os.txt</b> file if this is the first put.
-    # - a new group_name/key_name (like monica/surname) entry is added if required
-    # - a secret value is added against the key or updated if it already exists
-    # - a new session id and encryption key is generated and used to re-encrypt
+    # Execute the act of putting a string key and string value pair into a
+    # map at the chapter and verse location, overwriting if need be.
     def execute
 
-## @todo - rename appdb_content as master_db
-## @todo - rename appdb_content as master_db
-## @todo - rename appdb_content as master_db
-## @todo - rename appdb_content as master_db
-## @todo - rename appdb_content as master_db
-## @todo - rename appdb_content as master_db
-## @todo - rename appdb_content as master_db
-## @todo - rename appdb_content as master_db
-## @todo - rename appdb_content as master_db
-## @todo - rename appdb_content as master_db
-## @todo - rename appdb_content as master_db
-## @todo - rename appdb_content as master_db
-## @todo - rename appdb_content as master_db
-## @todo - rename appdb_content as master_db
-
       return unless ops_key_exists?
-      appdb_content = OpenKey::KeyApi.read_app_content()
-
-      puts "---\n"
-      puts "--- The Master Database (Before)\n"
-      puts "---\n"
-      puts JSON.pretty_generate( appdb_content )
-      puts "---\n"
-
-      return if unopened_envelope?( appdb_content )
-
-      envelope_id = ENVELOPE_KEY_PREFIX + appdb_content[ ENV_PATH ]
-      has_content = OpenKey::KeyApi.content_exists?( appdb_content[ envelope_id ] )
-
-      # --
-      # -- To get hold of the content we must either
-      # --
-      # --   a) unlock it using the breadcrumbs or
-      # --   b) start afresh with a new content db
-      # --
-      content_box = OpenKey::KeyApi.content_unlock( appdb_content[ envelope_id ] ) if has_content
-      content_box = OpenKey::KeyDb.new() unless has_content
-      content_hdr = create_header()
-
-      # --
-      # -- If no content envelope exists we need to place
-      # -- an empty one inside the appdb content database.
-      # --
-      appdb_content[ envelope_id ] = {} unless has_content
-
-      # --
-      # -- This is the PUT use case so we append a
-      # --
-      # --   a) key for the new dictionary entry
-      # --   b) value for the new dictionary entry
-      # --
-      # -- into the current content envelope and write
-      # -- the envelope to the content filepath.
-      # --
-      crumbs_dict = appdb_content[ envelope_id ]
-      content_box.create_entry( appdb_content[ KEY_PATH ], @secret_id, @secret_value )
-      OpenKey::KeyApi.content_lock( crumbs_dict, content_box.to_json, content_hdr )
-
-      puts "---\n"
-      puts "--- The Master Database (After)\n"
-      puts "---\n"
-      puts JSON.pretty_generate( appdb_content )
-      puts "---\n"
-
-      # --
-      # -- Three envelope crumbs namely the external ID, the
-      # -- random iv and the crypt key are written afreshinto
-      # -- the master database.
-      # --
-      OpenKey::KeyApi.write_app_content( content_hdr, appdb_content )
-      print_put_success
-
-      return
-
-
-# --->      secret_ids = @secret_id.split("/")
-# --->      if ( envelope.has_key? secret_ids.first )
-# --->        envelope[secret_ids.first][secret_ids.last] = @secret_value
-# --->      else
-# --->        envelope[secret_ids.first] = { secret_ids.last => @secret_value }
-# --->      end
-
-    end
+      master_db = OpenKey::KeyApi.read_master_db()
 
+      return if unopened_envelope?( master_db )
 
-    private
+      envelope_id = ENVELOPE_KEY_PREFIX + master_db[ ENV_PATH ]
+      has_content = OpenKey::KeyApi.db_envelope_exists?( master_db[ envelope_id ] )
 
+      # To get hold of the content we must either
+      #
+      #   a) unlock it using the breadcrumbs or
+      #   b) start afresh with a new content db
+      content_box = OpenKey::KeyDb.from_json( OpenKey::KeyApi.content_unlock( master_db[ envelope_id ] ) ) if has_content
+      content_box = OpenKey::KeyDb.new() unless has_content
+      content_hdr = create_header()
 
-    def print_put_success
-
-      puts ""
-      puts "Success putting a key/value pair into the open envelope."
-      puts "You can put more in and then close the envelope."
-      puts ""
-      puts "    ops close"
-      puts ""
-
-    end
-
+      # If no content envelope exists we need to place
+      # an empty one inside the appdb content database.
+      master_db[ envelope_id ] = {} unless has_content
+
+      # This is the PUT use case so we append a
+      #
+      #   a) key for the new dictionary entry
+      #   b) value for the new dictionary entry
+      #
+      # into the current content envelope and write
+      # the envelope to the content filepath.
+      crumbs_dict = master_db[ envelope_id ]
+      content_box.create_entry( master_db[ KEY_PATH ], @secret_id, @secret_value )
+      OpenKey::KeyApi.content_lock( crumbs_dict, content_box.to_json, content_hdr )
 
-    # Perform pre-conditional validations in preparation to executing the main flow
-    # of events for this use case. This method may throw the below exceptions.
-    #
-    # @raise [SafeDirNotConfigured] if the safe's url has not been configured
-    # @raise [EmailAddrNotConfigured] if the email address has not been configured
-    # @raise [StoreUrlNotConfigured] if the crypt store url is not configured
-    def pre_validation
+      # Three envelope crumbs namely the external ID, the
+      # random iv and the crypt key are written afresh into
+      # the master database.
+      OpenKey::KeyApi.write_master_db( content_hdr, master_db )
 
+      # Show the mini dictionary at the opened chapter and verse location
+      Show.new.flow_of_events
 
     end
 

data/lib/usecase/set.rb

@@ -2,10 +2,8 @@
 	
 module OpenSecret
 
-  require 'openssl'
-
   # The <b>set <em>use case</em></b> is the generic tool for setting configuration
-  # directives inside the ops workstation INI formatted file.
+  # directives inside the opensecret workstation INI formatted file.
   #
   # The mirror of this use case is <b><em>unset</em></b>.
   #
@@ -21,7 +19,7 @@ module OpenSecret
   # Error - if the directive path is not composed of two (fwd slash separated) parts
   # Error - if the directive path and/or value contains (or not) unacceptable characters
   #
-  class Set < Command
+  class Set < UseCase
 
     attr_writer :domain_name
 

data/lib/usecase/show.rb

@@ -0,0 +1,138 @@
+#!/usr/bin/ruby
+
+module OpenSecret
+
+  # Show the mini dictionary of key-value pairs within the logged in book
+  # at the opened chapter and verse.
+  #
+  # If no dictionary exists at the opened chapter and verse a suitable
+  # message is pushed out to the console.
+  class Show < UseCase
+
+    def get_chapter_data( chapter_key )
+      return OpenKey::KeyDb.from_json( OpenKey::KeyApi.content_unlock( chapter_key ) )
+    end
+
+    def execute
+
+      return unless ops_key_exists?
+      master_db = OpenKey::KeyApi.read_master_db()
+
+      return if unopened_envelope?( master_db )
+
+      chapter_id = ENVELOPE_KEY_PREFIX + master_db[ ENV_PATH ]
+      has_chapter = OpenKey::KeyApi.db_envelope_exists?( master_db[ chapter_id ] )
+      chapter_data = get_chapter_data( master_db[ chapter_id ] ) if has_chapter
+      has_verse = has_chapter && chapter_data.has_key?( master_db[ KEY_PATH ] )
+
+
+##global_variables - DONE
+##local_variables - DONE
+##instance_variables - DONE
+##class_variables - tough nut to crack with very little benefit (method class_variables not defined)
+
+=begin
+      puts ""
+      puts "QQQ QQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQ"
+      puts "QQQ ~~~~~~~~~~~~~ Global Variable Array List ~~~~~~~~~~~~~~~~ QQQQQ"
+      puts "QQQ QQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQ"
+
+      puts global_variables.inspect
+
+      puts "QQQ QQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQ"
+      puts "QQQ ~~~~~~~~~~~~~ Global Variable Values Printed ~~~~~~~~~~~~~~~~ QQQQQ"
+      puts "QQQ QQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQ"
+
+      global_variables.sort.each do |name|
+
+        puts "<<< ------------------------------------------------------------------->>>"
+        puts "<<< #{name.to_s} >>>"
+        puts "<<< ------------------------------------------------------------------->>>"
+        next if name.to_s.eql?( "$FILENAME" )
+        global_variable_value = eval "#{name}.inspect"
+        puts "<<< #{global_variable_value}"
+
+      end
+
+      puts ""
+      puts "QQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQ"
+      puts "QQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQ"
+      puts ""
+      puts "QQQQQQQQQQQ QQQQQQQQQQ QQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQ"
+      puts "QQQQQQQQQQQ Bug Finder QQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQ"
+      puts "QQQQQQQQQQQ QQQQQQQQQQ QQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQ"
+      puts ""
+      self.instance_variables.map do |attribute|
+        puts "=============================================="
+        puts "----------------------------------------------"
+        puts attribute
+        pp self.instance_variable_get(attribute)
+      end
+      puts "=============================================="
+      puts "QQQQQQQQQQQ QQQQQQQQQQ QQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQ"
+      puts "QQQQQQQQQQQ QQQQQQQQQQ QQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQ"
+      puts ""
+      puts "### ------------------------------------"
+      puts "### Inspect View"
+      puts "### ------------------------------------"
+      pp self.inspect
+      puts "### ------------------------------------"
+      puts "QQQQQQQQQQQ QQQQQQQQQQQQQQQ QQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQ"
+      puts "QQQQQQQQQQQ Local Variables QQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQ"
+      puts "QQQQQQQQQQQ QQQQQQQQQQQQQQQ QQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQ"
+
+      local_variables.map do |attribute|
+        puts "=============================================="
+        puts "----------------------------------------------"
+        puts attribute
+        pp binding.local_variable_get(attribute.to_sym)
+      end
+      puts "QQQQQQQQQQQ QQQQQQQQQQQQQQQ QQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQQ"
+
+      puts ""
+=end
+
+
+      return unless has_verse
+
+      line_dictionary = chapter_data[ master_db[ KEY_PATH ] ]
+
+      puts ""
+      puts "### ##################################\n"
+      puts "### chapter =>> #{master_db[ ENV_PATH ]}\n"
+      puts "### & verse =>> #{master_db[ KEY_PATH ]}\n"
+      puts "### # lines =>> #{line_dictionary.length}\n"
+      puts "### ##################################\n"
+      puts "--- ----------------------------------\n"
+      puts ""
+
+      showable_content = {}
+      line_dictionary.each do | key_str, value_object |
+
+        is_file = key_str.start_with? FILE_KEY_PREFIX
+        value_object.store( FILE_CONTENT_KEY, SECRET_MASK_STRING ) if is_file
+        showable_content.store( key_str[ FILE_KEY_PREFIX.length .. -1 ], value_object ) if is_file
+        next if is_file
+
+        is_secret = key_str.start_with? "@"
+        showable_val = SECRET_MASK_STRING if is_secret
+        showable_val = value_object unless is_secret
+        showable_content.store( key_str, showable_val )
+
+      end
+
+      puts JSON.pretty_generate( showable_content )
+      puts "--- ----------------------------------\n"
+      puts "### ##################################\n"
+      puts ""
+
+    end
+
+    private
+
+    SECRET_MASK_STRING = "***********************"
+
+  end
+
+
+end