safedb 0.3.1011 → 0.4.1002

data/lib/usecase/init.rb

@@ -1,61 +0,0 @@
-#!/usr/bin/ruby
-	
-module SafeDb
-
-  # The <b>init use case</b> initializes safe thus preparing it
-  # for the ability to lock secrets, unlock them, transport their keys and
-  # much more.
-  #
-  # safe is a <b>(glorified) placeholder</b>. It takes things in now,
-  # keeps them safe and gives them back later, in a <b>helpful manner</b>.
-  #
-  # == Alternat Error Flows
-  #
-  # An error will be thrown
-  #
-  # - if safe cannot create, extend, read or write the drive folder
-  # - if the domain is already in the configuration file
-  # - if domain has non alphanums, excl hyphens, underscores, @ symbols, periods
-  # - if domain does not begin or end with alphanums.
-  # - if non alpha-nums (excl at signs) appear consecutively
-  # - if no alpha-nums appear in the string
-  # - if the domain string's length is less than 5
-  # - if "safedb.net" appears twice (or more) in a directory tree
-  #
-  class Init < UseCase
-
-    attr_writer :password, :domain_name, :base_path
-
-
-    # The init use case prepares the <b>safe</b> so that you can <b>open</b> an envelope,
-    # <b>put</b> secrets into it and then <b>seal</b> (lock) it. Locking effectively writes
-    # crypted blocks to both keystore and crypt store.
-    def execute
-
-      return unless ops_key_exists?
-
-      KeyApi.init_app_domain( @domain_name, @base_path )
-      keys_setup = KeyApi.is_domain_keys_setup?( @domain_name )
-
-      if ( keys_setup )
-        print_already_initialized
-        return
-      end
-
-      domain_password = KeyPass.password_from_shell( true ) if @password.nil?
-      domain_password = @password unless @password.nil?
-
-      KeyApi.setup_domain_keys( @domain_name, domain_password, create_header() )
-      print_domain_initialized
-
-    end
-
-
-    def pre_validation
-    end
-
-
-  end
-
-
-end

data/lib/usecase/login.rb

@@ -1,72 +0,0 @@
-#!/usr/bin/ruby
-	
-module SafeDb
-
-  # 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.
-  #
-  # Here are some key facts about the login command
-  #
-  # - 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 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 < UseCase
-
-    attr_writer :password, :domain_name
-
-
-    def execute
-
-      return unless ops_key_exists?
-
-      unless ( KeyApi.is_domain_keys_setup?( @domain_name ) )
-        print_not_initialized
-        return
-      end
-
-############## Call [[ KeyApi.is_logged_in? ]] - then print msg and skip password collection below
-############## Call [[ KeyApi.is_logged_in? ]] - then print msg and skip password collection below
-############## Call [[ KeyApi.is_logged_in? ]] - then print msg and skip password collection below
-############## Call [[ KeyApi.is_logged_in? ]] - then print msg and skip password collection below
-############## Call [[ KeyApi.is_logged_in? ]] - then print msg and skip password collection below
-############## Call [[ KeyApi.is_logged_in? ]] - then print msg and skip password collection below
-
-      domain_secret = KeyPass.password_from_shell( false ) if @password.nil?
-      domain_secret = @password unless @password.nil?
-
-############## Use [[ KeyApi.valid_password? ]] and give error if not valid
-############## Use [[ KeyApi.valid_password? ]] and give error if not valid
-############## Use [[ KeyApi.valid_password? ]] and give error if not valid
-############## Use [[ KeyApi.valid_password? ]] and give error if not valid
-############## Use [[ KeyApi.valid_password? ]] and give error if not valid
-
-      KeyApi.do_login( @domain_name, domain_secret, create_header() )
-
-      view_uc = View.new
-      view_uc.flow_of_events
-
-    end
-
-
-    # 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
-
-    end
-
-
-  end
-
-
-end
-
-

data/lib/usecase/open.rb

@@ -1,71 +0,0 @@
-#!/usr/bin/ruby
-	
-module SafeDb
-
-  # 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.
-  #
-  # Also see the <b>reopen</b> command which only differs from open in that it
-  # fails if the path specified does not exist in either the sealed or session
-  # envelopes.
-  #
-  # == The Open Path Parameter
-  #
-  # Open must be called with a single <b>path</b> parameter with an optional
-  # single colon separating the outer (path to envelope) from the inner (path
-  # within envelope).
-  #
-  # == Open (Path) Pre-Conditions
-  #
-  # The domain must have been initialized on this machine stating the path to
-  # the base folder that contains the key and crypt material.
-  #
-  # To open a path these conditions must be true.
-  #
-  # - the shell session token must have been set at the session beginning
-  # - a successful <tt>login</tt> command must have been issued
-  # - the external drive (eg usb key) must be configured and accessible
-  #
-  # == Observable Value
-  #
-  # The observable value delivered by +[open]+ boils down to
-  #
-  # - an openkey (eg asdfx1234) and corresponding open encryption key
-  # - open encryption key written to <tt>~/.safedb.net/open.keys/asdfx1234.x.txt</tt>
-  # - the opened path (ending in filename) written to session.cache base in [safe]
-  # - the INI string (were the file to be decrypted) would look like the below
-  #
-  #     [session]
-  #     base.path = home/wifi
-  #
-  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
-    # the path in envelope to the point of interest.
-    attr_writer :env_path, :key_path
-
-    def execute
-
-      return unless ops_key_exists?
-      master_db = KeyApi.read_master_db()
-
-      master_db[ ENV_PATH ] = @env_path
-      master_db[ KEY_PATH ] = @key_path
-
-      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
-
-
-  end
-
-
-end

data/lib/usecase/print.rb

@@ -1,40 +0,0 @@
-#!/usr/bin/ruby
-	
-module SafeDb
-
-  class Print < UseCase
-
-    attr_writer :key_name
-
-    def get_chapter_data( chapter_key )
-      return KeyDb.from_json( 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 = 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

@@ -1,81 +0,0 @@
-#!/usr/bin/ruby
-	
-module SafeDb
-
-  # 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
-  # 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
-  class Put < UseCase
-
-    attr_writer :secret_id, :secret_value
-
-    # 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
-
-      return unless ops_key_exists?
-      master_db = KeyApi.read_master_db()
-
-      return if unopened_envelope?( master_db )
-
-      envelope_id = ENVELOPE_KEY_PREFIX + master_db[ ENV_PATH ]
-      has_content = 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 = KeyDb.from_json( KeyApi.content_unlock( master_db[ envelope_id ] ) ) if has_content
-      content_box = 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.
-      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 )
-      KeyApi.content_lock( crumbs_dict, content_box.to_json, content_hdr )
-
-      # Three envelope crumbs namely the external ID, the
-      # random iv and the crypt key are written afresh into
-      # the master database.
-      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
-
-
-  end
-
-
-end

data/lib/usecase/show.rb

@@ -1,138 +0,0 @@
-#!/usr/bin/ruby
-
-module SafeDb
-
-  # 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 KeyDb.from_json( KeyApi.content_unlock( chapter_key ) )
-    end
-
-    def execute
-
-      return unless ops_key_exists?
-      master_db = KeyApi.read_master_db()
-
-      return if unopened_envelope?( master_db )
-
-      chapter_id = ENVELOPE_KEY_PREFIX + master_db[ ENV_PATH ]
-      has_chapter = 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