safedb 0.4.1002 → 0.5.1001

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3bcafea21f4204ecebc6712dd926e839aeb8c078904487528b44de4b1f87b4d8
-  data.tar.gz: 256015d30eb46362a1d3923d6a7cf0c1d88942b67c4f5cd8e7dce6b6b5fb40b4
+  metadata.gz: 745b886e46c4ed9a32467c96411d6ae720778445be31a814d53f6dd2fedd80f1
+  data.tar.gz: 977cd56ed9ff4c5f2ee9f9a019eb6e92fc25715382bdb74f7fcde190b92a45b7
 SHA512:
-  metadata.gz: d013b6386bfc912ede2b8ad1736309c48cbbbb36d3e23731c092f4e041df47a3d012aa9a5ea5ecebb841d8f0066f040da2b3fb1c1e61adfff424997bc429f2ca
-  data.tar.gz: 42a6f28ecad6fc9fcbd759b4abdcfea468ebfe491cd75775698055b52946042009123edf6c1b5cc8bd56cd78fc8f78bd33ee42861cf3b973de44c67a7cc39beb
+  metadata.gz: 5ee47c8b27a1bb6a6b32736f2e2cfeb4577b4e3f247ca7f434a4ed76c2e21bfb812678dd36dc256821412da73edff505455fabe526c18d6b82d57056016af56f
+  data.tar.gz: 412b4638f8e58dd020630c56d9ba05772705ce0251d23d591e30c9ccd12b00e8c3826271b98c36779c54628b2d85aed8534c685a54b663899bc821811d214619

data/CONTRIBUTING.md

@@ -54,7 +54,7 @@ safedb is automatically released by Jenkins using a GitOps style pipeline define
 - quality numbers passed by the Reek code quality analyzer
 - available rubygems.org credentials in ~/.gem/credentials
 
-## release safedb to RubyGems.org
+## Release to RubyGems.org
 
 Once only use **`gem push`** at the repository root to create a **rubygems API key** and slurp it up from the **`~/.gem/credentials`** with **`safe file rubygems.org.credentials ~/.gem/credentials`**
 Now when releasing we eject the file back into **`~/.gem/credentials`**, secure it ( with **`sudo chmod 0600 credentials`** ) and then issue the below command from the **gem-release** gem.
@@ -63,26 +63,26 @@ Now when releasing we eject the file back into **`~/.gem/credentials`**, secure
 
 The gem bump (and release) command bumps up the patch (or major or minor) version, tags the repository, pushes the changes and releases to rubygems.org
 
+## Common Development Commands
 
+These commands will be used frequently while developing the safe.
 
-## safedb development environment commands
+- `rake install`
+- `cucumber`
+- `git checkout -b feature.verb-noun`
+- `git add; git commit;`
+- `git cherry -v origin`
+- `git cherry -v origin feature.verb-noun`
+- `git push -u origin feature.verb-noun`
+- `git pull origin master`
+- `git pull origin feature.verb-noun`
 
-### `rake install`
-### `cucumber`
-### `git checkout -b feature.commit-branch`
-### `git add; git commit;`
-### `git cherry -v origin`
-### `git cherry -v origin feature.commit-branch`
-### `git push -u origin feature.commit-branch`
-### `git pull origin master`
-### `git pull origin feature.commit-branch`
+When ready to merge the feature development branch into master these commands will be used.
 
-## common git feature merge commands
-
-### `git checkout master`
-### `git pull origin master`
-### `git merge feature.commit-branch`
-### `git push -u origin master`
+- `git checkout master`
+- `git pull origin master`
+- `git merge feature.verb-noun`
+- `git push origin master`
 
 
 ## Branch Naming Convention
@@ -95,15 +95,15 @@ Branch names begin with either
 
 Branch names are then typically a **verb-noun concatenation** like
 
-- feature.safe-inport-export
-- refactor.book-id-create-algorithm
-- refactor.validate-book-names
+- feature.copy-paste
+- bug.login-error
+- refactor.cucumber-features
 
-## how to git push to safedb.net
+## git push to github.com/devops4me/safedb.net
 
 Those with priveleges to release to safedb.net will have a private key to push pull requests into the repository.
 
-This is how to setup the **ssh config** and **pem private key**.
+Described here is setting up the **ssh config**, the **pem private key**, then cloning the repository with https, creating a branch, merging and finally pusing using **git ssh**.
 
 ```
 safe login safe.ecosystem
@@ -114,9 +114,21 @@ safe eject safedb.code.private.key
 chmod 600 safedb.code.private.key
 cd <<repositories-folder>>
 ssh -i ~/.ssh/safedb.code.private.key.pem -vT git@safedb.code
-git clone git@safedb.code:devops4me/safedb.net.git mirror.safedb.code
+git clone https://github.com/devops4me/safedb.net safedb.net
+git remote set-url --push origin git@safedb.code:devops4me/safedb.net.git
 ```
 
 If a config file already exists then safe will back it up with a timestamp prefix before clobbering the file. Now bump up the major, minor or patch versions, then commit.
 
+## Continuous Integration using Jenkins 2.0 Docker Pipeline
+
+safedb.net has Dockerfiles through which the Cucumber/Aruba BDD (behaviour driven development) tests are run within
+
+- **Ubuntu 16.04 and 18.04**
+- Raspbian
+- **RedHat Enterprise Linux (RHEL)**
+- CoreOS containers
+
+### CI/CD Pipeline from Git to RubyGems.org
 
+The Jenkinsfile template used is in the RubyGem category so succesful builds, quality inspection and tests result in a new version of the software being released to RubyGems.org

data/README.md

@@ -503,41 +503,81 @@ Again you can configure 1 to 32 which guarantees that the generated password seq
 
 There are 62 alpha-numerics which is the starting point and smallest source pool of usable choosable characters for a printable character sequence.
 
+
+## Password Strength vs Password Length
+
+Strength indicates the number of possible printable characters to choose from whilst median length indicates the approximate size of the generated secret. Both strengths and lengths run from 1 to 32. The defaults are
+
+- a weighted strength of 12 (a bucket of 70 characters)
+- a weighted length of 12 (a median length of 22 characters)
+
+## Including and Excluding Characters
+
+The stated strength indicates the characters that can appear in the password. This can be configured to
+
+- <tt>exclude</tt> characters inside of the stated strength
+- <tt>include</tt> characters outside of the stated strength
+
+```
+safe secret               # generate with default strength and length
+safe secret --length=4    # generate secret between 10 and 16 characters
+safe secret --strength=6  # include alpha-numerics, underscore, period and hyphens
+```
+
+To adjust the secret's character bucket we can include and exclude characters.
+
+```
+safe secret --length 16 --strength 12 --include ampersand,dollar --exclude hat,period
+safe secret -l=16 -s=12 -i=ampersand,dollar -e=hat,period
+```
+
+## Config Levels Reminder
+
+If you open a verse and then use set to add configuraion, the config scope will cover just that verse. You can move to chapter and/or to book level.
+
+Configuration can be
+
+- command scoped (in command options)
+- session scoped (in session indices or environment variables)
+- book, chapter or verse scoped ( in book indices)
+- database scoped (within master indices)
+
+
         - ---------------------- | -------------------- - --------- -
-        | Password Makeup Weight |  #   | Char Name     | Character |
+        | Password Strength      |  #   | Char Name     | Character |
         | ---------------------- | -----| ------------- | --------- |
-        |         1              |  62  | alpha-nums    | A-Za-z0-9 |
+        |         1              |  26  | lowercase     |  a-z      |
+        |         1              |  36  | digits        |  0-9      |
+        |         1              |  62  | uppercase     |  A-Z      |
         |         2              |  63  | underscore    |   _       |
         |         3              |  64  | period        |   .       |
         |         4              |  65  | hyphen        |   -       |
-        |         5              |  66  | at symbol     |   @       |
+        |         5              |  66  | at            |   @       |
         |         6              |  67  | squiggle      |   ~       |
-        |         7              |  68  | hyphen        |   -       |
-        |         8              |  69  | plus sign     |   +       |
-        |         9              |  70  | percent       |   %       |
-        |         10             |  71  | equals        |   =       |
-        |         11             |  72  | SPACE         |           |
-        |         12             |  73  | fwd slash     |   /       |
-        |         13             |  74  | hat symbol    |   ^       |
-        |         14             |  75  | soft open     |   (       |
-        |         15             |  76  | soft close    |   )       |
-        |         16             |  77  | square open   |   [       |
-        |         17             |  78  | square close  |   ]       |
-        |         18             |  79  | curly open    |   {       |
-        |         19             |  80  | curly close   |   }       |
-        |         20             |  81  | angle open    |   <       |
-        |         21             |  82  | angle close   |   >       |
-        |         22             |  83  | pipe symbol   |   |       |
-        |         23             |  84  | hash symbol   |   #       |
-        |         24             |  85  | question mark |   ?       |
-        |         25             |  86  | colon         |   :       |
-        |         26             |  87  | semi-colon    |   ;       |
-        |         27             |  88  | comma         |   ,       |
-        |         28             |  89  | asterix       |   *       |
-        |         29             |  90  | ampersand     |   &       |
-        |         30             |  91  | exclamation   |   !       |
-        |         31             |  92  | dollar sign   |   $       |
-        |         32             |  93  | back tick     |   `       |
+        |         7              |  68  | plus          |   +       |
+        |         26             |  87  | comma         |   ,       |
+        |         24             |  85  | colon         |   :       |
+        |         25             |  86  | semicolon     |   ;       |
+        |         8              |  69  | percent       |   %       |
+        |         9              |  70  | equals        |   =       |
+        |         13             |  74  | hat           |   ^       |
+        |         10             |  71  | pipe          |   |       |
+        |         12             |  73  | fwdslash      |   /       |
+        |         14             |  75  | softopen      |   (       |
+        |         15             |  76  | softclose     |   )       |
+        |         16             |  77  | squareopen    |   [       |
+        |         17             |  78  | squareclose   |   ]       |
+        |         18             |  79  | curlyopen     |   {       |
+        |         19             |  80  | curlyclose    |   }       |
+        |         20             |  81  | angleopen     |   <       |
+        |         21             |  82  | angleclose    |   >       |
+        |         22             |  83  | hash          |   #       |
+        |         23             |  84  | question      |   ?       |
+        |         27             |  88  | asterix       |   *       |
+        |         28             |  89  | ampersand     |   &       |
+        |         29             |  90  | exclamation   |   !       |
+        |         30             |  91  | dollar        |   $       |
+        |         31             |  92  | backtick      |   `       |
         | ---------------------- | -----| ------------- | --------- |
 
 Use the full set of **93 printable characters** when protecting high value assets like databases.

data/lib/cli.rb

@@ -109,13 +109,19 @@ class CLI < Thor
   # inaccessible or the call originates from non-interactive software.
   option :password, :aliases => '-p'
 
+  # The <tt>--clip</tt> option says the password is to be read from the
+  # clipboard. Usually one needs to just highlight the text without
+  # actually copying it with the mouse or Ctrl-c
+################  method_option :clip, :type => :boolean, :aliases => "-c"
+
   # Login in order to securely interact with your safe credentials.
   # @param book_name [String] the name of the credentials book to login to
   def login( book_name = nil )
-    log.info(x) { "login to the safe credentials book called [#{book_name}]." }
+    log.info(x) { "login attempt to the safe book called [#{book_name}]." }
     login_uc = SafeDb::Login.new
     login_uc.book_name = book_name unless book_name.nil?
     login_uc.password = options[ :password ] if options[ :password ]
+###################    login_uc.clip = true if options[ :clip ]
     login_uc.flow()
   end
 
@@ -198,19 +204,19 @@ class CLI < Thor
 
 
   # Description of the diff use case command from the point of view
-  # of either a checkout from master to branch, a checkin from branch
+  # of either a refresh from master to branch, a commit from branch
   # to master or a diff listing prophesying about both.
-  desc "diff", "master and branch diff with --checkin (-i), --checkout (-o) or both."
+  desc "diff", "master and branch diff with --commit (-i), --refresh (-o) or both."
 
-  # A checkin is basically a copy-overwrite operation which does not finesse
-  # like the merging checkout does. The diff report illustrates that the master
+  # A commit is basically a copy-overwrite operation which does not finesse
+  # like the merging refresh does. The diff report illustrates that the master
   # will essentially reflect the working branch's current state.
-  method_option :checkin, :type => :boolean, :aliases => "-i"
+  method_option :commit, :type => :boolean, :aliases => "-c"
 
-  # A checkout is effectively an incoming merge of the master's data
-  # structure into the working branch. With checkouts nothing ever gets
+  # A refresh is effectively an incoming merge of the master's data
+  # structure into the working branch. With refreshs nothing ever gets
   # deleted.
-  method_option :checkout, :type => :boolean, :aliases => "-o"
+  method_option :refresh, :type => :boolean, :aliases => "-r"
 
   # The <b>diff use case</b> spells out the key differences between the safe book
   # on the master line the one on the current working branch.
@@ -218,37 +224,37 @@ class CLI < Thor
   # By default when conflicts occur, priority is given to the current working branch.
   # No parameters are required to perform a diff.
   def diff
-    log.info(x) { "prophesy list of checkout and/or checkin actions. CLI options are #{options.to_s()}" }
+    log.info(x) { "prophesy list of refresh and/or commit actions. CLI options are #{options.to_s()}" }
     diff_uc = SafeDb::Diff.new()
-    diff_uc.checkin = true if options[ :checkin ]
-    diff_uc.checkout = true if options[ :checkout ]
+    diff_uc.commit = true if options[ :commit ]
+    diff_uc.refresh = true if options[ :refresh ]
     diff_uc.flow()
   end
 
 
 
-  # Description of the checkin use case command.
-  desc "checkin", "commit (save) the branch changes by putting them into master."
+  # Description of the commit use case command.
+  desc "commit", "commit (save) the branch changes by putting them into master."
 
-  # The <b>checkin use case</b> commits any changes made to the safe book into
+  # The <b>commit use case</b> commits any changes made to the safe book into
   # master. This is straightforward if the master's state has not been forwarded
   # by a ckeckin from another (shell) branch.
-  def checkin
+  def commit
     log.info(x) { "commit (save) any changes made to this branch into the master." }
-    SafeDb::CheckIn.new.flow()
+    SafeDb::Commit.new.flow()
   end
 
 
 
-  # Description of the checkout use case command.
-  desc "checkout", "refresh (update) the working branch with changes from the master."
+  # Description of the refresh use case command.
+  desc "refresh", "refresh (update) the working branch with changes from the master."
 
-  # The <b>checkout use case</b> commits any changes made to the safe book into
+  # The <b>refresh use case</b> commits any changes made to the safe book into
   # master. This is straightforward if the master's state has not been forwarded
   # by a ckeckin from another (shell) branch.
-  def checkout
+  def refresh
     log.info(x) { "refresh (update) the working branch with changes from the master." }
-    SafeDb::CheckOut.new.flow()
+    SafeDb::Refresh.new.flow()
   end
 
 

data/lib/controller/admin/access.rb

@@ -4,7 +4,7 @@ module SafeDb
 
   # Parent to use cases like Init and Login that perform early
   # initialize workflows.
-  class AccessUc < UseCase
+  class AccessUc < Controller
 
     attr_writer :password, :book_name
 

data/lib/controller/admin/commit.rb

@@ -0,0 +1,53 @@
+#!/usr/bin/ruby
+	
+module SafeDb
+
+  # The <b>commit use case</b> commits any changes made to the safe book into
+  # master. This is straightforward if the master's state has not been forwarded
+  # by a ckeckin from another (shell) branch.
+  #
+  # The mechanics of a simple in-sync commit is to
+  #
+  # - sync the master crypts to exactly mimic the branch crypts
+  # - tell master the content id of the book index file
+  # - tell master what the current random iv (initialization vector) is
+  # - create a new commit ID and set it on both master and branch
+  # - set the master's last updated date and time
+  #
+  class Commit < Controller
+
+
+    # The <b>commit use case</b> commits any changes made to the safe book into
+    # master. This is straightforward if the master's state has not been forwarded
+    # by a ckeckin from another (shell) branch.
+    def execute
+
+      @book.print_book_mark()
+
+      unless @book.can_commit?()
+
+        puts "Cannot commit as master has moved forward."
+        puts "First see the difference, then refresh, and then commit."
+        puts ""
+        puts "   safe diff"
+        puts "   safe refresh"
+        puts "   safe commit"
+        puts ""
+        return
+
+      end
+
+      StateMigrate.commit( @book )
+
+      puts "The commit was on #{KeyNow.readable()}\n"
+      puts "Commit from branch to master was successful.\n"
+      puts ""
+
+
+    end
+
+
+  end
+
+
+end

data/lib/controller/admin/diff.rb

@@ -4,12 +4,12 @@ module SafeDb
 
   # The <b>diff use case</b> spells out the key differences between the safe book
   # on the master line the one on the current working branch. There are two types
-  # of diff - a checkout diff or a checkin diff.
+  # of diff - a refresh diff or a commit diff.
   #
-  # == a checkout diff
+  # == a refresh diff
   #
-  # A checkout is effectively an incoming merge of the master's data
-  # structure into the working branch. With checkouts nothing ever gets
+  # A refresh is effectively an incoming merge of the master's data
+  # structure into the working branch. With refreshs nothing ever gets
   # deleted.
   #
   # No delete is self-evident in this list of only <tt>4 prophetic</tt>
@@ -20,50 +20,48 @@ module SafeDb
   # - this line will be added
   # - this branch's line value will be overwritten with the value from master
   #
-  # == a checkin diff
+  # == a commit diff
   #
-  # A checkout merges whilst a checkin is effectively a hard copy that destroys
+  # A refresh merges whilst a commit is effectively a hard copy that destroys
   # whatever is on the master making it exactly reflect the branch's current state.
   #
-  # The three addition state changes prophesized by a checkout can also occur on
-  # checkins. However checkins can also prophesize that
+  # The three addition state changes prophesized by a refresh can also occur on
+  # commits. However commits can also prophesize that
   #
   # - this master's line value will be overwritten with the branch's value
   # - this chapter will be removed
   # - this verse will be removed
   # - this line will be removed
   #
-  class Diff < UseCase
+  class Diff < Controller
 
-    # The checkin and checkout boolean flags that signal which way round to do the diff
-    attr_writer :checkin, :checkout
+    # The commit and refresh boolean flags that signal which way round to do the diff
+    attr_writer :commit, :refresh
 
     # The <b>diff use case</b> compares the database state of the branch with
     # that of the master and displays the results without masking sensitive
     # credentials.
     def execute
 
-      book = Book.new()
-
-      print_both = @checkin.nil?() && @checkout.nil?()
-      print_checkin = !@checkin.nil?() || print_both
-      print_checkout = !@checkout.nil?() || print_both
+      print_both = @commit.nil?() && @refresh.nil?()
+      print_commit = !@commit.nil?() || print_both
+      print_refresh = !@refresh.nil?() || print_both
 
       puts ""
-      puts " == Birth Day := #{book.init_time()}\n"
-      puts " == Book Name := #{book.book_name()} [#{book.book_id}]\n"
-      puts " == Book Mark := #{book.get_open_chapter_name()}/#{book.get_open_verse_name()}\n" if book.is_opened?()
+      puts " == Birth Day := #{@book.init_time()}\n"
+      puts " == Book Name := #{@book.book_name()} [#{@book.book_id}]\n"
+      puts " == Book Mark := #{@book.get_open_chapter_name()}/#{@book.get_open_verse_name()}\n" if @book.is_opened?()
       puts ""
 
-      master_data = book.to_master_data()
-      branch_data = book.to_branch_data()
+      master_data = @book.to_master_data()
+      branch_data = @book.to_branch_data()
 
-      StateInspect.checkout_prophecies( master_data, branch_data ) if print_checkout
-      StateInspect.checkin_prophecies( master_data, branch_data ) if print_checkin
+      StateInspect.refresh_prophecies( master_data, branch_data ) if print_refresh
+      StateInspect.commit_prophecies( master_data, branch_data ) if print_commit
 
       puts ""
-      puts "   master has #{master_data.length()} chapters, and #{book.get_master_verse_count()} verses.\n"
-      puts "   branch has #{branch_data.length()} chapters, and #{book.get_branch_verse_count()} verses.\n"
+      puts "   master has #{master_data.length()} chapters, and #{@book.get_master_verse_count()} verses.\n"
+      puts "   branch has #{branch_data.length()} chapters, and #{@book.get_branch_verse_count()} verses.\n"
       puts ""
 
     end

data/lib/controller/admin/export.rb

@@ -8,30 +8,28 @@ module SafeDb
   #
   # The --print flag demands that the exported text goes to stdout otherwise it
   # will be placed in an aptly named file in  the present working directory.
-  class Export < UseCase
+  class Export < Controller
 
     def execute
 
-      book = Book.new()
-
       puts ""
       puts "### #############################################################\n"
       puts "--- --------------------------------------------------------------\n"
       puts ""
-      puts " The Birthday := #{book.init_time()}\n"
-      puts " Book Name    := #{book.book_name()}\n"
-      puts " Book Id      := #{book.book_id()}\n"
-      puts " Open Chapter := #{book.get_open_chapter_name()}\n" if book.has_open_chapter_name?()
-      puts " Open Verse   := #{book.get_open_verse_name()}\n"   if book.has_open_verse_name?()
+      puts " The Birthday := #{@book.init_time()}\n"
+      puts " Book Name    := #{@book.book_name()}\n"
+      puts " Book Id      := #{@book.book_id()}\n"
+      puts " Open Chapter := #{@book.get_open_chapter_name()}\n" if @book.has_open_chapter_name?()
+      puts " Open Verse   := #{@book.get_open_verse_name()}\n"   if @book.has_open_verse_name?()
       puts ""
 
-      export_filename = "safedb.#{KeyNow.yyjjj_hhmm_ss_nanosec()}.#{book.book_id()}.json"
+      export_filename = "safedb.#{KeyNow.yyjjj_hhmm_ss_nanosec()}.#{@book.book_id()}.json"
       export_filepath = File.join( Dir.pwd, export_filename )
 
       exported_struct = {}
       verse_count = 0
 
-      book.branch_chapter_keys().each_pair do | chapter_name, chapter_keys |
+      @book.branch_chapter_keys().each_pair do | chapter_name, chapter_keys |
 
         chapter_data = Content.unlock_branch_chapter( chapter_keys )
         verse_count += chapter_data.length
@@ -42,7 +40,7 @@ module SafeDb
       File.write( export_filepath, JSON.pretty_generate( exported_struct ) + "\n" )
 
       puts ""
-      puts "Number of chapters exported >> #{book.chapter_count()}"
+      puts "Number of chapters exported >> #{@book.chapter_count()}"
       puts "Number of verses exported >> #{verse_count}"
       puts "The export filename is #{export_filename}"
       puts "The Present Working Directory is #{Dir.pwd}"

data/lib/controller/admin/goto.rb

@@ -12,7 +12,7 @@ module SafeDb
   # Goto with the number effectively shortcuts the open pinpointer.
   # Show prints out the verse lines at the opened path but masks any secrets.
   # Tell also prints out the verse lines but unabashedly displays secrets.
-  class Goto < UseCase
+  class Goto < Controller
 
     # The index (number) starting with 1 of the envelope and key-path
     # combination that should be opened.
@@ -20,9 +20,8 @@ module SafeDb
 
     def execute
 
-      book = Book.new()
       goto_location = 0
-      book.branch_chapter_keys().each_pair do | chapter_name, chapter_keys |
+      @book.branch_chapter_keys().each_pair do | chapter_name, chapter_keys |
 
         chapter_data = Content.unlock_branch_chapter( chapter_keys )
         chapter_data.each_key do | verse_name |

data/lib/controller/admin/import.rb

@@ -7,7 +7,7 @@ module SafeDb
   # chapter of the source JSON structure into the corresponding chapter of
   # the destination, handling duplicate key/value pairs in a sensible way.
   #
-  class Import < UseCase
+  class Import < Controller
 
     attr_writer :import_filepath
 
@@ -17,16 +17,14 @@ module SafeDb
     # the destination, handling duplicate key/value pairs in a sensible way.
     def execute
 
-      book = Book.new()
-
       abort "Cannot find the import file at path #{@import_filepath}" unless File.exists?( @import_filepath )
 
       puts ""
       puts "### #############################################################\n"
       puts "--- -------------------------------------------------------------\n"
       puts ""
-      puts " Book Name   := #{book.book_name()}\n"
-      puts " Book Id     := #{book.book_id()}\n"
+      puts " Book Name   := #{@book.book_name()}\n"
+      puts " Book Id     := #{@book.book_id()}\n"
       puts " Import from := #{@import_filepath}\n"
       puts " Import time := #{KeyNow.readable()}\n"
       puts ""
@@ -34,11 +32,11 @@ module SafeDb
       new_verse_count = 0
       data_store = DataStore.from_json( File.read( @import_filepath ) )
       data_store.each_pair do | chapter_name, chapter_data |
-        book.import_chapter( chapter_name, chapter_data )
+        @book.import_chapter( chapter_name, chapter_data )
         new_verse_count += chapter_data.length()
       end
 
-      book.write()
+      @book.write()
 
       puts ""
       puts "#{data_store.length()} chapters and #{new_verse_count} verses were successfully imported.\n"

data/lib/controller/admin/login.rb

@@ -15,8 +15,21 @@ module SafeDb
   # - 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
+
+  # - an environment variable
+  # - the system clipboard (cleared after reading)
+  # - a file whose path is a command parameter
+  # - a file in a pre-agreed location
+  # - a file in the present directory (with a pre-agreed name)
+  # - a URL from a parameter or pre-agreed
+  # - the shell's secure password reader
   class Login < AccessUc
 
+    # If the clip switch is present it signifies that the password should
+    # be read in from the clipboard. Any text selection puts text into the
+    # the clipboard - no need specifically to use Ctrl-c (copy).
+    attr_writer :clip
+
     def execute
 
 # @todo => in parent class Auth validate the book name
@@ -36,8 +49,9 @@ module SafeDb
 
 # @todo => search for password in environment variable
 
-      book_password = KeyPass.password_from_shell( false ) if @password.nil?
-      book_password = @password unless @password.nil?
+####      book_password = Clipboard.read_password() if @clip
+      book_password = KeyPass.password_from_shell( false ) if( @password.nil?() && @clip.nil?() )
+      book_password = @password unless @password.nil?()
 
 # @todo => if password is correct - if not print out an error.
 

data/lib/controller/admin/logout.rb

@@ -2,7 +2,7 @@
 	
 module SafeDb
 
-  class Logout < UseCase
+  class Logout < Controller
 
     def execute
 

data/lib/controller/admin/open.rb

@@ -12,17 +12,16 @@ module SafeDb
   # exists you use the <tt>safe reopen</tt> command. This command produces an error
   # if it cannot find specified chapter and verse.
   #
-  class Open < UseCase
+  class Open < Controller
 
     # The chapter and verse of this book that are to be opened.
     attr_writer :chapter, :verse
 
     def execute
 
-      book = Book.new()
-      book.set_open_chapter_name( @chapter )
-      book.set_open_verse_name( @verse )
-      book.write()
+      @book.set_open_chapter_name( @chapter )
+      @book.set_open_verse_name( @verse )
+      @book.write()
 
       # Show the mini dictionary at the opened chapter and verse location
       # More work is needed when for when only the chapter is opened in